Skip to content

Commit 7f07c07

Browse files
authored
Merge pull request #1685 from wilzbach/move-docs-json-to-generated2
Move generated docs{,-prerelease}.json to $GENERATED v2
2 parents ba2baee + e19f135 commit 7f07c07

File tree

2 files changed

+21
-22
lines changed

2 files changed

+21
-22
lines changed

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ css/cssmenu.css
3232
*.min.*
3333

3434
deleteme.*
35-
docs-prerelease.json
36-
docs.json
3735
.dub/
3836
dpl-docs/dpl-docs
3937
modlist-release.ddoc

posix.mak

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ PHOBOS_STABLE_DIR=${PHOBOS_DIR}-${LATEST}
4747
################################################################################
4848
# Automatically generated directories
4949
GENERATED=.generated
50+
G=$(GENERATED)
5051
PHOBOS_DIR_GENERATED=$(GENERATED)/phobos-prerelease
5152
PHOBOS_STABLE_DIR_GENERATED=$(GENERATED)/phobos-release
5253
# The assert_writeln_magic tool transforms all source files from Phobos. Hence
@@ -473,24 +474,24 @@ ${DOC_OUTPUT_DIR}/phobos-prerelease/index.verbatim : verbatim.ddoc \
473474

474475
apidocs-prerelease : ${DOC_OUTPUT_DIR}/library-prerelease/sitemap.xml ${DOC_OUTPUT_DIR}/library-prerelease/.htaccess
475476
apidocs-release : ${DOC_OUTPUT_DIR}/library/sitemap.xml ${DOC_OUTPUT_DIR}/library/.htaccess
476-
apidocs-serve : docs-prerelease.json
477+
apidocs-serve : $G/docs-prerelease.json
477478
${DPL_DOCS} serve-html --std-macros=html.ddoc --std-macros=dlang.org.ddoc --std-macros=std.ddoc --std-macros=macros.ddoc --std-macros=std-ddox.ddoc \
478479
--override-macros=std-ddox-override.ddoc --package-order=std \
479-
--git-target=master --web-file-dir=. docs-prerelease.json
480+
--git-target=master --web-file-dir=. $<
480481

481-
${DOC_OUTPUT_DIR}/library-prerelease/sitemap.xml : docs-prerelease.json
482+
${DOC_OUTPUT_DIR}/library-prerelease/sitemap.xml : $G/docs-prerelease.json
482483
@mkdir -p $(dir $@)
483484
${DPL_DOCS} generate-html --file-name-style=lowerUnderscored --std-macros=html.ddoc --std-macros=dlang.org.ddoc --std-macros=std.ddoc --std-macros=macros.ddoc --std-macros=std-ddox.ddoc \
484485
--override-macros=std-ddox-override.ddoc --package-order=std \
485486
--git-target=master $(DPL_DOCS_PATH_RUN_FLAGS) \
486-
docs-prerelease.json ${DOC_OUTPUT_DIR}/library-prerelease
487+
$< ${DOC_OUTPUT_DIR}/library-prerelease
487488

488-
${DOC_OUTPUT_DIR}/library/sitemap.xml : docs.json
489+
${DOC_OUTPUT_DIR}/library/sitemap.xml : $G/docs.json
489490
@mkdir -p $(dir $@)
490491
${DPL_DOCS} generate-html --file-name-style=lowerUnderscored --std-macros=html.ddoc --std-macros=dlang.org.ddoc --std-macros=std.ddoc --std-macros=macros.ddoc --std-macros=std-ddox.ddoc \
491492
--override-macros=std-ddox-override.ddoc --package-order=std \
492493
--git-target=v${LATEST} $(DPL_DOCS_PATH_RUN_FLAGS) \
493-
docs.json ${DOC_OUTPUT_DIR}/library
494+
$< ${DOC_OUTPUT_DIR}/library
494495

495496
${DOC_OUTPUT_DIR}/library/.htaccess : dpl_release_htaccess
496497
@mkdir -p $(dir $@)
@@ -507,36 +508,36 @@ else
507508
DMD_EXCLUDE += -e /scanmach/d -e /libmach/d
508509
endif
509510

510-
docs.json : ${DMD_STABLE} ${DRUNTIME_STABLE_DIR} \
511+
$G/docs.json : ${DMD_STABLE} ${DRUNTIME_STABLE_DIR} \
511512
${PHOBOS_STABLE_FILES_GENERATED} | dpl-docs
512513
find ${DRUNTIME_STABLE_DIR}/src -name '*.d' | \
513-
sed -e /unittest.d/d -e /gcstub/d > .release-files.txt
514+
sed -e /unittest.d/d -e /gcstub/d > $G/.release-files.txt
514515
find ${PHOBOS_STABLE_DIR_GENERATED} -name '*.d' | \
515-
sed -e /unittest.d/d -e /windows/d | sort >> .release-files.txt
516+
sed -e /unittest.d/d -e /windows/d | sort >> $G/.release-files.txt
516517
${DMD_STABLE} -c -o- -version=CoreDdoc -version=StdDdoc -Df.release-dummy.html \
517-
-Xfdocs.json -I${PHOBOS_STABLE_DIR_GENERATED} @.release-files.txt
518-
${DPL_DOCS} filter docs.json --min-protection=Protected \
518+
-Xf$@ -I${PHOBOS_STABLE_DIR_GENERATED} @$G/.release-files.txt
519+
${DPL_DOCS} filter $@ --min-protection=Protected \
519520
--only-documented $(MOD_EXCLUDES_PRERELEASE)
520-
rm .release-files.txt .release-dummy.html
521+
rm -f $G/.release-files.txt $G/.release-dummy.html
521522

522523
# DDox tries to generate the docs for all `.d` files. However for dmd this is tricky,
523524
# because the `{mach, elf, mscoff}` are platform dependent.
524525
# Thus the need to exclude these files (and the `objc_glue.d` file).
525-
docs-prerelease.json : ${DMD} ${DMD_DIR} ${DRUNTIME_DIR} \
526+
$G/docs-prerelease.json : ${DMD} ${DMD_DIR} ${DRUNTIME_DIR} \
526527
${PHOBOS_FILES_GENERATED} | dpl-docs
527528
find ${DMD_DIR}/src -name '*.d' | \
528529
sed -e /mscoff/d -e /objc_glue.d/d ${DMD_EXCLUDE} \
529-
> .prerelease-files.txt
530+
> $G/.prerelease-files.txt
530531
find ${DRUNTIME_DIR}/src -name '*.d' | sed -e '/gcstub/d' \
531-
-e /unittest/d >> .prerelease-files.txt
532+
-e /unittest/d >> $G/.prerelease-files.txt
532533
find ${PHOBOS_DIR_GENERATED} -name '*.d' | sed -e /unittest.d/d \
533-
-e /windows/d | sort >> .prerelease-files.txt
534+
-e /windows/d | sort >> $G/.prerelease-files.txt
534535
${DMD} -J$(DMD_DIR)/res -J$(dir $(DMD)) -c -o- -version=MARS -version=CoreDdoc \
535-
-version=StdDdoc -Df.prerelease-dummy.html \
536-
-Xfdocs-prerelease.json -I${PHOBOS_DIR_GENERATED} @.prerelease-files.txt
537-
${DPL_DOCS} filter docs-prerelease.json --min-protection=Protected \
536+
-version=StdDdoc -Df$G/.prerelease-dummy.html \
537+
-Xf$@ -I${PHOBOS_DIR_GENERATED} @$G/.prerelease-files.txt
538+
${DPL_DOCS} filter $@ --min-protection=Protected \
538539
--only-documented $(MOD_EXCLUDES_RELEASE)
539-
rm .prerelease-files.txt .prerelease-dummy.html
540+
rm -f $G/.prerelease-files.txt $G/.prerelease-dummy.html
540541

541542
################################################################################
542543
# binary targets for DDOX

0 commit comments

Comments
 (0)