diff options
| author | mchung <none@none> | 2017-05-12 13:29:22 -0700 |
|---|---|---|
| committer | mchung <none@none> | 2017-05-12 13:29:22 -0700 |
| commit | d0b0f5cc310fe0e055139212d5e96fbcaf9473e9 (patch) | |
| tree | 5517d45d9290de99ff6f97accf22d696e6cfbd7f | |
| parent | 18b5eb23d3085e4d3093202a6029bf13d8f5edf9 (diff) | |
| download | jdk9-d0b0f5cc310fe0e055139212d5e96fbcaf9473e9.tar.gz | |
8180208: Provide a new docs bundle page
Reviewed-by: ihse, jjg
| -rw-r--r-- | make/Docs.gmk | 24 | ||||
| -rw-r--r-- | make/Main.gmk | 9 |
2 files changed, 29 insertions, 4 deletions
diff --git a/make/Docs.gmk b/make/Docs.gmk index 33d8ab6..2859070 100644 --- a/make/Docs.gmk +++ b/make/Docs.gmk @@ -165,6 +165,11 @@ JAVASE_JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition \ $(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 @@ $(eval $(call SetupApiDocsGeneration, JAVASE_API, \ # 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-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS) 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 diff --git a/make/Main.gmk b/make/Main.gmk index c08e405..ab6eb7d 100644 --- a/make/Main.gmk +++ b/make/Main.gmk @@ -380,6 +380,9 @@ docs-javase-api-modulegraph: 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 @@ update-build-docs: 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 @@ else # 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 @@ ifeq ($(ENABLE_FULL_DOCS), true) 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 |