jdk-sandbox: comparison make/Docs.gmk

equal deleted inserted replaced

-:ed9ef56bc7d5
+:f78e7ce060b0
 include Modules.gmk
 include ModuleTools.gmk
 include ProcessMarkdown.gmk
 include ToolsJdk.gmk
 include ZipArchive.gmk
+include TextFileProcessing.gmk
 # This is needed to properly setup DOCS_MODULES.
 $(eval $(call ReadImportMetaData))
 ################################################################################
 $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
 # URLs
 JAVADOC_BASE_URL := https://docs.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&amp;id=homepage
 BUG_SUBMIT_URL := https://bugreport.java.com/bugreport/
-COPYRIGHT_URL := {@docroot}/../legal/copyright.html
+COPYRIGHT_URL := legal/copyright.html
 LICENSE_URL := https://www.oracle.com/technetwork/java/javase/terms/license/java$(VERSION_NUMBER)speclicense.html
 REDISTRIBUTION_URL := https://www.oracle.com/technetwork/java/redist-137594.html
 # In order to get a specific ordering it's necessary to specify the total
 # ordering of tags as the tags are otherwise ordered in order of definition.
 -tag 'implSpec:a:Implementation Requirements:' \
 -tag 'implNote:a:Implementation Note:' \
 -tag param \
 -tag return \
 -tag throws \
+-taglet build.tools.taglet.JSpec\$$JLS \
+-taglet build.tools.taglet.JSpec\$$JVMS \
 -taglet build.tools.taglet.ModuleGraph \
+-taglet build.tools.taglet.ToolGuide \
 -tag since \
 -tag serialData \
 -tag factory \
 -tag see \
--tag 'jvms:a:See <cite>The Java&trade; Virtual Machine Specification</cite>:' \
--tag 'jls:a:See <cite>The Java&trade; Language Specification</cite>:' \
 -taglet build.tools.taglet.ExtLink \
 -taglet build.tools.taglet.Incubating \
+-taglet build.tools.taglet.Preview \
 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
 $(CUSTOM_JAVADOC_TAGS) \
 #
 # The reference tags must stay stable to allow for comparisons across the
 # Workaround stylesheet bug
 HEADER_STYLE := style="margin-top: 9px;"
 else
 HEADER_STYLE := style="margin-top: 14px;"
 endif
+# $1 - Relative prefix to COPYRIGHT_URL
+COPYRIGHT_BOTTOM = \
+<a href="$(strip $1)$(COPYRIGHT_URL)">Copyright</a> \
+&copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \
+$(COMPANY_ADDRESS).<br>All rights reserved. \
+Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \
+<a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \
+$(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) -->
 JAVADOC_BOTTOM := \
 <a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \
 For further API reference and developer documentation see the \
 <a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \
 Documentation</a>, which contains more detailed, \
 developer-targeted descriptions with conceptual overviews, definitions \
 of terms, workarounds, and working code examples.<br> \
 Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \
 the US and other countries.<br> \
-<a href="$(COPYRIGHT_URL)">Copyright</a> \
+$(call COPYRIGHT_BOTTOM, {@docroot}/../)
-&copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \
-$(COMPANY_ADDRESS).<br>All rights reserved. \
-Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \
-<a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \
-$(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) -->
 JAVADOC_TOP := \
 <div style="padding: 6px; text-align: center; font-size: 80%; \
 font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \
 font-weight: normal;">$(DRAFT_TEXT)</div>
 JAVASE_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition
 ################################################################################
 # Functions
-# Helper function for creating a png file from a dot file generated by the
+# Helper function for creating a svg file from a dot file generated by the
 # GenGraphs tool.
 # param 1: SetupJavadocGeneration namespace ($1)
 # param 2: module name
 #
-define setup_gengraph_dot_to_png
+define setup_gengraph_dot_to_svg
 $1_$2_DOT_SRC :=  $$($1_GENGRAPHS_DIR)/$2.dot
-$1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.png
+$1_$2_SVG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.svg
-# For each module needing a graph, create a png file from the dot file
+# For each module needing a graph, create a svg file from the dot file
 # generated by the GenGraphs tool and store it in the target dir.
 $$(eval $$(call SetupExecute, gengraphs_png_$1_$2, \
 INFO := Running dot for module graphs for $2, \
 DEPS := $$(gengraphs_$1_TARGET), \
 OUTPUT_FILE := $$($1_$2_PNG_TARGET), \
 SUPPORT_DIR := $$($1_GENGRAPHS_DIR), \
 COMMAND := $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC), \
 ))
-$1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET)
+$1_MODULEGRAPH_TARGETS += $$($1_$2_SVG_TARGET)
 endef
 # Helper function to create the overview.html file to use with the -overview
 # javadoc option.
 # Returns the filename as $1_OVERVIEW.
 # Figure out all modules, both specified and transitive indirect exports, that
 # will be processed by javadoc.
 $1_INDIRECT_EXPORTS := $$(call FindTransitiveIndirectDepsForModules, $$($1_MODULES))
 $1_ALL_MODULES := $$(sort $$($1_MODULES) $$($1_INDIRECT_EXPORTS))
-$1_JAVA_ARGS := -Dextlink.spec.version=$$(VERSION_SPECIFICATION)
+$1_JAVA_ARGS := -Dextlink.spec.version=$$(VERSION_SPECIFICATION) \
+	-Djspec.version=$$(VERSION_SPECIFICATION)
 ifeq ($$(ENABLE_FULL_DOCS), true)
 # Tell the ModuleGraph taglet to generate html links to soon-to-be-created
-# png files with module graphs.
+# svg files with module graphs.
 $1_JAVA_ARGS += -DenableModuleGraph=true
 endif
 # Start with basic options and tags
 ifeq ($$($1_OPTIONS), )
 $$($1_ALL_MODULES) $$($1_JAVADOC_CMD)
 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
 $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps)
 # Get a list of all files in all the source dirs for all included modules
-$1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \
+$1_SOURCE_DEPS := $$(call FindFiles, $$(wildcard $$(foreach module, \
 $$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module)))))
 $$(eval $$(call SetupExecute, javadoc_$1, \
 WARN := Generating $1 javadoc for $$(words $$($1_ALL_MODULES)) modules, \
 INFO := Javadoc modules: $$($1_ALL_MODULES), \
 ))
 $1_JAVADOC_TARGETS := $$(javadoc_$1_TARGET)
 ifeq ($$(ENABLE_FULL_DOCS), true)
-# We have asked ModuleGraph to generate links to png files. Now we must
+# We have asked ModuleGraph to generate links to svg files. Now we must
-# produce the png files.
+# produce the svg files.
 # Locate which modules has the @moduleGraph tag in their module-info.java
 $1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \
 $$(if $$(shell $$(GREP) -e @moduleGraph \
 $$(wildcard $$(addsuffix /module-info.java, \
 # For each module needing a graph, create a png file from the dot file
 # generated by the GenGraphs tool and store it in the target dir.
 # They will depend on gengraphs_$1_TARGET, and will be added to $1.
 $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \
-$$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \
+$$(eval $$(call setup_gengraph_dot_to_svg,$1,$$m)) \
 )
 endif
 endef
 ################################################################################
 # Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and
 # REFERENCE_API_MODULEGRAPH_TARGETS.
 ################################################################################
+# Use this variable to control which spec files are included in the output.
+# Format: space-delimited list of names, including at most one '%' as a
+# wildcard. Spec source files match if their filename or any enclosing folder
+# name matches one of the items in SPEC_FILTER.
+SPEC_FILTER := %
+ApplySpecFilter = \
+$(strip $(foreach file, $(1), \
+$(eval searchkeys := $(subst /, ,$(subst $(WORKSPACE_ROOT),,$(file)))) \
+$(if $(filter $(SPEC_FILTER), $(searchkeys)), \
+$(file) \
+) \
+))
 # Copy the global resources, including the top-level redirect index.html
-GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources/
+GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources
 $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \
 SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \
-FILES := $(call CacheFind, $(GLOBAL_SPECS_RESOURCES_DIR)), \
+FILES := $(call ApplySpecFilter, $(call FindFiles, $(GLOBAL_SPECS_RESOURCES_DIR))), \
 DEST := $(DOCS_OUTPUTDIR), \
 ))
 JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES)
 # Copy the legal notices distributed with the docs bundle
 $(eval $(call SetupCopyFiles, COPY_DOCS_LEGAL_NOTICES, \
 SRC := $(TOPDIR)/src/jdk.javadoc/share/legal, \
-FILES := $(wildcard $(TOPDIR)/src/jdk.javadoc/share/legal/*), \
+FILES := $(call ApplySpecFilter, $(wildcard $(TOPDIR)/src/jdk.javadoc/share/legal/*)), \
 DEST := $(DOCS_OUTPUTDIR)/legal, \
 ))
 JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES)
 ################################################################################
 # Copy JDK specs files
-# For all html documentation in $module/share/specs directories, copy it
+# For all non html/md files in $module/share/specs directories, copy them
 # unmodified
 ALL_MODULES := $(call FindAllModules)
-COPY_SPEC_FILTER := %.html %.gif %.jpg %.mib %.css
+COPY_SPEC_FILTER := %.gif %.jpg %.mib %.css
 $(foreach m, $(ALL_MODULES), \
 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
 $(foreach d, $(SPECS_$m), \
-$(if $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
+$(if $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \
 $(eval $(call SetupCopyFiles, COPY_$m, \
 SRC := $d, \
-FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
+FILES := $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \
 DEST := $(DOCS_OUTPUTDIR)/specs/, \
 )) \
 $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
 ) \
 ) \
 )
+# Create copyright footer variables. We need different variables for different
+# relative paths to the copyright.html file. The number 0-2 below represent how
+# many extra directory levels down below the specs dir the specs html file is
+# located.
+SPECS_BOTTOM = <footer class="legal-footer"><hr/>$(COPYRIGHT_BOTTOM)</footer>
+# The legal dir is one ../ below the specs dir, so start with one ../.
+specs_bottom_rel_path := ../
+$(foreach n, 0 1 2, \
+$(eval SPECS_BOTTOM_$n := $(call SPECS_BOTTOM,$(specs_bottom_rel_path))) \
+$(eval specs_bottom_rel_path := $(specs_bottom_rel_path)../) \
+)
+SPECS_TOP := $(if $(filter true, $(IS_DRAFT)), <header class="draft-header">$(DRAFT_TEXT)</header>)
+# For all html files in $module/share/specs directories, copy and add the
+# copyright footer.
+$(foreach m, $(ALL_MODULES), \
+$(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
+$(foreach d, $(SPECS_$m), \
+$(foreach f, $(call ApplySpecFilter, $(filter %.html, $(call FindFiles, $d))), \
+$(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \
+$(eval $m_$f_NAME := PROCESS_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \
+$(eval $(call SetupTextFileProcessing, $($m_$f_NAME), \
+SOURCE_FILES := $f, \
+SOURCE_BASE_DIR := $d, \
+OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \
+REPLACEMENTS := \
+<body> => <body>$(SPECS_TOP) ; \
+</body> => $(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))</body>, \
+)) \
+$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \
+) \
+) \
+)
 ifeq ($(ENABLE_PANDOC), true)
 # For all markdown files in $module/share/specs directories, convert them to
 # html, if we have pandoc (otherwise we'll just skip this).
 GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css
 $(foreach m, $(ALL_MODULES), \
 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
 $(foreach d, $(SPECS_$m), \
-$(if $(filter %.md, $(call CacheFind, $d)), \
+$(foreach f, $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, $d))), \
-$(eval $m_$d_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $d, $(TOPDIR)))) \
+$(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \
-$(eval $(call SetupProcessMarkdown, $($m_$d_NAME), \
+$(eval $m_$f_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \
+$(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \
 SRC := $d, \
-FILES := $(filter %.md, $(call CacheFind, $d)), \
+FILES := $f, \
 DEST := $(DOCS_OUTPUTDIR)/specs/, \
 CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
+OPTIONS := -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))', \
+REPLACEMENTS := \
+		@@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION) ; \
+		@@VERSION_STRING@@ => $(VERSION_STRING), \
+POST_PROCESS := $(TOOL_FIXUPPANDOC), \
 )) \
-$(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \
+$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \
 ) \
 ) \
 )
 # For all markdown files in $module/share/man directories, convert them to
 $(TOPDIR)/make/scripts/pandoc-html-manpage-filter.js
 $(foreach m, $(ALL_MODULES), \
 $(eval MAN_$m := $(call FindModuleManDirs, $m)) \
 $(foreach d, $(MAN_$m), \
-$(if $(filter %.md, $(call CacheFind, $d)), \
+$(foreach f, $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, $d))), \
-$(eval $m_$d_NAME := MAN_TO_HTML_$m_$(strip $(call RelativePath, $d, $(TOPDIR)))) \
+$(eval $m_$f_NAME := MAN_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \
-$(eval $(call SetupProcessMarkdown, $($m_$d_NAME), \
+$(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \
 SRC := $d, \
-FILES := $(filter %.md, $(call CacheFind, $d)), \
+FILES := $f, \
 DEST := $(DOCS_OUTPUTDIR)/specs/man, \
 FILTER := $(PANDOC_HTML_MANPAGE_FILTER), \
 CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
-REPLACEMENTS := @@VERSION_SHORT@@ => $(VERSION_SHORT), \
+REPLACEMENTS := \
+		@@COPYRIGHT_YEAR@@ => $(COPYRIGHT_YEAR) ; \
+		@@VERSION_SHORT@@ => $(VERSION_SHORT) ; \
+		@@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION), \
+OPTIONS := --toc -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_1)', \
+POST_PROCESS := $(TOOL_FIXUPPANDOC), \
 EXTRA_DEPS := $(PANDOC_HTML_MANPAGE_FILTER) \
 $(PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT), \
 )) \
-$(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \
+$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \
 ) \
 ) \
 )
 # The html generated from markdown also needs the css file
 endif
 # Special treatment for generated documentation
 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
-$(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \
+ifneq ($(call ApplySpecFilter, $(JDWP_PROTOCOL)), )
-FILES := $(JDWP_PROTOCOL), \
+$(eval $(call SetupTextFileProcessing, PROCESS_JDWP_PROTOCOL, \
-DEST := $(DOCS_OUTPUTDIR)/specs/jdwp, \
+SOURCE_FILES := $(JDWP_PROTOCOL), \
-))
+OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/jdwp, \
-JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL)
+REPLACEMENTS := \
+<body> => <body>$(SPECS_TOP) ; \
+</body> => $(SPECS_BOTTOM_1)</body>, \
+))
+JDK_SPECS_TARGETS += $(PROCESS_JDWP_PROTOCOL)
+endif
 # Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical).
 JVMTI_HTML ?= $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
-$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
+ifneq ($(call ApplySpecFilter, $(JVMTI_HTML)), )
-FILES := $(JVMTI_HTML), \
+$(eval $(call SetupTextFileProcessing, PROCESS_JVMTI_HTML, \
-DEST := $(DOCS_OUTPUTDIR)/specs, \
+SOURCE_FILES := $(JVMTI_HTML), \
-))
+OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \
-JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML)
+REPLACEMENTS := \
+<body> => <body>$(SPECS_TOP) ; \
+</body> => $(SPECS_BOTTOM_0)</body>, \
+))
+JDK_SPECS_TARGETS += $(PROCESS_JVMTI_HTML)
+endif
 ################################################################################
 # Optional target which bundles all generated javadocs into a zip archive.
 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
 ))
 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
 ################################################################################
+# Hook to include the corresponding custom file, if present.
+$(eval $(call IncludeCustomExtension, Docs-post.gmk))
+################################################################################
+# Bundles all generated specs into a zip archive, skipping javadocs.
+SPECS_ZIP_NAME := jdk-$(VERSION_STRING)-specs.zip
+SPECS_ZIP_FILE := $(OUTPUTDIR)/bundles/$(SPECS_ZIP_NAME)
+$(eval $(call SetupZipArchive, BUILD_SPECS_ZIP, \
+SRC := $(DOCS_OUTPUTDIR), \
+ZIP := $(SPECS_ZIP_FILE), \
+EXTRA_DEPS := $(JDK_SPECS_TARGETS), \
+))
+SPECS_ZIP_TARGETS += $(BUILD_SPECS_ZIP)
+################################################################################
 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) $(JDK_API_CUSTOM_TARGETS)
 docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS)
 docs-jdk-specs: $(JDK_SPECS_TARGETS)
 docs-jdk-index: $(JDK_INDEX_TARGETS)
 docs-zip: $(ZIP_TARGETS)
+docs-specs-zip: $(SPECS_ZIP_TARGETS)
 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
 docs-javase-api-modulegraph docs-reference-api-javadoc \
-docs-reference-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip
+docs-reference-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip \
+docs-specs-zip
 .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
 docs-javase-api-javadoc docs-javase-api-modulegraph \
 docs-reference-api-javadoc docs-reference-api-modulegraph docs-jdk-specs \
-docs-jdk-index docs-zip
+docs-jdk-index docs-zip docs-specs-zip

branch	ihse-setupexecute-branch
changeset 58834	f78e7ce060b0
parent 57231	461128671cdf
parent 58726	449555c346d9