OpenJDK / jdk / hs
changeset 45105:bf3dae998ca2
8180208: Provide a new docs bundle page
Reviewed-by: ihse, jjg
| author | mchung |
|---|---|
| date | Fri, 12 May 2017 13:29:22 -0700 |
| parents | b8a6cd8674d1 |
| children | c74e98882464 |
| files | make/Docs.gmk make/Main.gmk |
| diffstat | 2 files changed, 29 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/make/Docs.gmk Fri May 12 19:11:14 2017 +0200 +++ b/make/Docs.gmk Fri May 12 13:29:22 2017 -0700 @@ -165,6 +165,11 @@ $(VERSION_SPECIFICATION)<br>API Specification ################################################################################ + +JDK_DOCS_INDEX_HTML_TITLE := Java™ Platform, Standard Edition Development Kit \ + (JDK™) $(VERSION_SPECIFICATION) Specification<br>$(DRAFT_MARKER_TITLE) + +################################################################################ # Functions # Helper function for creating a png file from a dot file generated by the @@ -357,6 +362,18 @@ # JAVASE_API_MODULEGRAPH_TARGETS. ################################################################################ + +JDK_DOCS_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html + +$(JDK_DOCS_INDEX_HTML): $(BUILD_JIGSAW_TOOLS) + $(call LogInfo, Generating docs bundle index page) + $(MKDIR) -p $(@D) + $(TOOL_GEN_DOCS_BUNDLE_PAGE) --title '$(JDK_DOCS_INDEX_HTML_TITLE)' \ + --output $@ + +JDK_DOCS_INDEX_HTML_TARGETS := $(JDK_DOCS_INDEX_HTML) + +################################################################################ # Copy JDK specs files # For all html documentation in $module/share/specs directories, copy it @@ -454,10 +471,13 @@ docs-jdk-specs: $(JDK_SPECS_TARGETS) +docs-jdk-index: $(JDK_DOCS_INDEX_HTML_TARGETS) + docs-zip: $(ZIP_TARGETS) all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \ - docs-javase-api-modulegraph docs-jdk-specs docs-zip + docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \ - docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs docs-zip + docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \ + docs-jdk-index docs-zip
--- a/make/Main.gmk Fri May 12 19:11:14 2017 +0200 +++ b/make/Main.gmk Fri May 12 13:29:22 2017 -0700 @@ -380,6 +380,9 @@ docs-jdk-specs: +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-jdk-specs) +docs-jdk-index: + +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-jdk-index) + docs-zip: +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-zip) @@ -388,7 +391,7 @@ ALL_TARGETS += docs-jdk-api-javadoc docs-jdk-api-modulegraph \ docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \ - docs-zip update-build-docs + docs-jdk-index docs-zip update-build-docs ################################################################################ # Cross compilation support @@ -797,6 +800,8 @@ # The gensrc steps for hotspot and jdk.jdi create html spec files. docs-jdk-specs: hotspot-$(JVM_VARIANT_MAIN)-gensrc jdk.jdi-gensrc + docs-jdk-index: exploded-image buildtools-modules + docs-zip: docs-jdk test: jdk-image test-image @@ -926,7 +931,7 @@ docs-javase-api: docs-javase-api-modulegraph endif -docs-jdk: docs-jdk-api docs-jdk-specs +docs-jdk: docs-jdk-api docs-jdk-specs docs-jdk-index docs-javase: docs-javase-api # alias for backwards compatibility