< prev index next >

make/Docs.gmk

Print this page

        

*** 1,6 **** ! # Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as # published by the Free Software Foundation. Oracle designates this --- 1,6 ---- ! # Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as # published by the Free Software Foundation. Oracle designates this
*** 24,40 **** default: all include $(SPEC) include MakeBase.gmk - include Execute.gmk 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)) ################################################################################ --- 24,38 ---- default: all include $(SPEC) include MakeBase.gmk include Modules.gmk include ProcessMarkdown.gmk include ZipArchive.gmk ! include $(TOPDIR)/make/ToolsJdk.gmk ! include $(TOPDIR)/make/ModuleTools.gmk # This is needed to properly setup DOCS_MODULES. $(eval $(call ReadImportMetaData)) ################################################################################
*** 63,73 **** $(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 := 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. --- 61,71 ---- $(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 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.
*** 83,100 **** -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 \ -taglet build.tools.taglet.ExtLink \ -taglet build.tools.taglet.Incubating \ -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ $(CUSTOM_JAVADOC_TAGS) \ # --- 81,97 ---- -tag 'implSpec:a:Implementation Requirements:' \ -tag 'implNote:a:Implementation Note:' \ -tag param \ -tag return \ -tag throws \ -taglet build.tools.taglet.ModuleGraph \ -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 \ -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ $(CUSTOM_JAVADOC_TAGS) \ #
*** 148,182 **** 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> \ ! $(call COPYRIGHT_BOTTOM, {@docroot}/../) 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> ################################################################################ # JDK javadoc titles/text snippets JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION) JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \ --- 145,183 ---- HEADER_STYLE := style="margin-top: 9px;" else HEADER_STYLE := style="margin-top: 14px;" endif 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> \ ! &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> + JDK_INDEX_CONTENT := \ + <!DOCTYPE html> \ + <html lang="en"> \ + <head> \ + <meta http-equiv="refresh" content="0;url=api/index.html"> \ + </head> \ + </html> + ################################################################################ # JDK javadoc titles/text snippets JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION) JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \
*** 200,216 **** $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.png # 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. ! $$(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) endef # Helper function to create the overview.html file to use with the -overview --- 201,214 ---- $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.png # 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. ! $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER) ! $$(call MakeDir, $$(@D)) ! $$(call ExecuteWithLog, $$($1_$2_DOT_SRC), \ ! $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC)) $1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET) endef # Helper function to create the overview.html file to use with the -overview
*** 274,285 **** # 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) \ ! -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. $1_JAVA_ARGS += -DenableModuleGraph=true --- 272,282 ---- # 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) ifeq ($$(ENABLE_FULL_DOCS), true) # Tell the ModuleGraph taglet to generate html links to soon-to-be-created # png files with module graphs. $1_JAVA_ARGS += -DenableModuleGraph=true
*** 342,366 **** $$($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 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), \ ! DEPS := $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) $$($1_SOURCE_DEPS) \ ! $$($1_OVERVIEW), \ ! OUTPUT_DIR := $$($1_TARGET_DIR), \ ! SUPPORT_DIR := $$(SUPPORT_OUTPUTDIR)/docs, \ ! COMMAND := $$($1_JAVADOC_CMD) -d $$($1_TARGET_DIR) $$($1_OPTIONS) \ ! $$($1_LOG_OPTION), \ ! )) ! $1_JAVADOC_TARGETS := $$(javadoc_$1_TARGET) ifeq ($$(ENABLE_FULL_DOCS), true) # We have asked ModuleGraph to generate links to png files. Now we must # produce the png files. --- 339,363 ---- $$($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_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module))))) ! # Javadoc creates a lot of files but use index.html as a marker ! $$($1_TARGET_DIR)/index.html: $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) \ ! $$($1_SOURCE_DEPS) $$($1_OVERVIEW) ! $$(call LogWarn, Generating $1 javadoc for \ ! $$(words $$($1_ALL_MODULES)) modules) ! $$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES)) ! $$(call MakeDir, $$($1_TARGET_DIR)) ! $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \ ! $$($1_JAVADOC_CMD) -d $$($1_TARGET_DIR) \ ! $$($1_OPTIONS) $$($1_LOG_OPTION)) ! $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html ifeq ($$(ENABLE_FULL_DOCS), true) # We have asked ModuleGraph to generate links to png files. Now we must # produce the png files.
*** 376,397 **** # running JVM and output .dot files for all existing modules. GENGRAPHS_PROPS := \ $$(TOPDIR)/make/jdk/src/classes/build/tools/jigsaw/javadoc-graphs.properties $1_GENGRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-gengraphs ! $$(eval $$(call SetupExecute, gengraphs_$1, \ ! INFO := Running gengraphs for $1 documentation, \ ! DEPS := $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS), \ ! OUTPUT_DIR := $$($1_GENGRAPHS_DIR), \ ! COMMAND := $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \ ! --dot-attributes $$(GENGRAPHS_PROPS), \ ! )) # 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)) \ ) endif endef --- 373,395 ---- # running JVM and output .dot files for all existing modules. GENGRAPHS_PROPS := \ $$(TOPDIR)/make/jdk/src/classes/build/tools/jigsaw/javadoc-graphs.properties $1_GENGRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-gengraphs + $1_GENGRAPHS_MARKER := $$($1_GENGRAPHS_DIR)/_gengraphs_run.marker ! $$($1_GENGRAPHS_MARKER): $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS) ! $$(call LogInfo, Running gengraphs for $1 documentation) ! $$(call MakeDir, $$($1_GENGRAPHS_DIR)) ! $$(call ExecuteWithLog, $$($1_GENGRAPHS_DIR)/gengraphs, \ ! $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \ ! --dot-attributes $$(GENGRAPHS_PROPS) && \ ! $$(TOUCH) $$($1_GENGRAPHS_MARKER)) # 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 $1_GENGRAPHS_MARKER, and will be added to $1. $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \ $$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \ ) endif endef
*** 485,499 **** # Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and # REFERENCE_API_MODULEGRAPH_TARGETS. ################################################################################ ! # Copy the global resources, including the top-level redirect index.html GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources/ $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \ SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \ ! FILES := $(call FindFiles, $(GLOBAL_SPECS_RESOURCES_DIR)), \ DEST := $(DOCS_OUTPUTDIR), \ )) JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES) # Copy the legal notices distributed with the docs bundle --- 483,504 ---- # Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and # REFERENCE_API_MODULEGRAPH_TARGETS. ################################################################################ ! JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html ! ! $(JDK_INDEX_HTML): ! $(ECHO) '$(JDK_INDEX_CONTENT)' > $@ ! ! JDK_INDEX_TARGETS += $(JDK_INDEX_HTML) ! ! # Copy the global 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)), \ DEST := $(DOCS_OUTPUTDIR), \ )) JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES) # Copy the legal notices distributed with the docs bundle
*** 505,630 **** JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES) ################################################################################ # Copy JDK specs files ! # For all non html/md files in $module/share/specs directories, copy them # unmodified ALL_MODULES := $(call FindAllModules) ! 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 FindFiles, $d)), \ $(eval $(call SetupCopyFiles, COPY_$m, \ SRC := $d, \ ! FILES := $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d)), \ DEST := $(DOCS_OUTPUTDIR)/specs/, \ )) \ $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \ ) \ ) \ ) ! # Create copyright footer files that can be provided as input to pandoc. We ! # need different files 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. Each file name is ! # stored in a variable SPECS_BOTTOM_FILE_$n where $n is 0, 1 or 2. ! SPECS_BOTTOM = <hr/>$(COPYRIGHT_BOTTOM) ! # 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_FILE_$n := $(SUPPORT_OUTPUTDIR)/docs/full-specs-bottom-$n.txt) \ ! $(eval SPECS_BOTTOM_$n := $(call SPECS_BOTTOM,$(specs_bottom_rel_path))) \ ! $(eval $(SPECS_BOTTOM_FILE_$n): \ ! $(call DependOnVariable, SPECS_BOTTOM_$n) ; \ ! $(PRINTF) '$(SPECS_BOTTOM_$n)' > $$@ \ ! ) \ ! $(eval specs_bottom_rel_path := $(specs_bottom_rel_path)../) \ ! ) ! ! # 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, $(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> => $(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), \ ! $(foreach f, $(filter %.md, $(call FindFiles, $d)), \ ! $(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \ ! $(eval $m_$f_BOTTOM_FILE := $(SPECS_BOTTOM_FILE_$($m_$f_NOF_SUBDIRS))) \ ! $(eval $m_$f_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ ! $(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \ SRC := $d, \ ! FILES := $f, \ DEST := $(DOCS_OUTPUTDIR)/specs/, \ CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ - OPTIONS := -A $($m_$f_BOTTOM_FILE), \ - EXTRA_DEPS := $($m_$f_BOTTOM_FILE), \ - POST_PROCESS := $(TOOL_FIXUPPANDOC), \ )) \ ! $(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ ) \ ) \ ) # For all markdown files in $module/share/man directories, convert them to # html. - - # Create dynamic man pages from markdown using pandoc. We need - # PANDOC_HTML_MANPAGE_FILTER, a wrapper around - # PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk. - - # We should also depend on the source javascript filter - PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT := \ - $(TOPDIR)/make/scripts/pandoc-html-manpage-filter.js - $(foreach m, $(ALL_MODULES), \ $(eval MAN_$m := $(call FindModuleManDirs, $m)) \ $(foreach d, $(MAN_$m), \ ! $(foreach f, $(filter %.md, $(call FindFiles, $d)), \ ! $(eval $m_$f_NAME := MAN_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ ! $(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \ SRC := $d, \ ! FILES := $f, \ DEST := $(DOCS_OUTPUTDIR)/specs/man, \ - FILTER := $(PANDOC_HTML_MANPAGE_FILTER), \ CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ REPLACEMENTS := @@VERSION_SHORT@@ => $(VERSION_SHORT), \ - OPTIONS := -A $(SPECS_BOTTOM_FILE_1), \ - POST_PROCESS := $(TOOL_FIXUPPANDOC), \ - EXTRA_DEPS := $(PANDOC_HTML_MANPAGE_FILTER) \ - $(PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT) \ - $(SPECS_BOTTOM_FILE_1), \ )) \ ! $(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ ) \ ) \ ) # The html generated from markdown also needs the css file --- 510,576 ---- JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES) ################################################################################ # Copy JDK specs files ! # For all html documentation in $module/share/specs directories, copy it # unmodified ALL_MODULES := $(call FindAllModules) ! COPY_SPEC_FILTER := %.html %.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)), \ $(eval $(call SetupCopyFiles, COPY_$m, \ SRC := $d, \ ! FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \ DEST := $(DOCS_OUTPUTDIR)/specs/, \ )) \ $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \ ) \ ) \ ) ! ifeq ($(ENABLE_FULL_DOCS), true) # For all markdown files in $module/share/specs directories, convert them to ! # html. 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)), \ ! $(eval $m_$d_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $d, $(TOPDIR)))) \ ! $(eval $(call SetupProcessMarkdown, $($m_$d_NAME), \ SRC := $d, \ ! FILES := $(filter %.md, $(call CacheFind, $d)), \ DEST := $(DOCS_OUTPUTDIR)/specs/, \ CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ )) \ ! $(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \ ) \ ) \ ) # For all markdown files in $module/share/man directories, convert them to # html. $(foreach m, $(ALL_MODULES), \ $(eval MAN_$m := $(call FindModuleManDirs, $m)) \ $(foreach d, $(MAN_$m), \ ! $(if $(filter %.md, $(call CacheFind, $d)), \ ! $(eval $m_$d_NAME := MAN_TO_HTML_$m_$(strip $(call RelativePath, $d, $(TOPDIR)))) \ ! $(eval $(call SetupProcessMarkdown, $($m_$d_NAME), \ SRC := $d, \ ! FILES := $(filter %.md, $(call CacheFind, $d)), \ DEST := $(DOCS_OUTPUTDIR)/specs/man, \ CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ REPLACEMENTS := @@VERSION_SHORT@@ => $(VERSION_SHORT), \ )) \ ! $(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \ ) \ ) \ ) # The html generated from markdown also needs the css file
*** 632,658 **** endif # Special treatment for generated documentation JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html ! $(eval $(call SetupTextFileProcessing, PROCESS_JDWP_PROTOCOL, \ ! SOURCE_FILES := $(JDWP_PROTOCOL), \ ! OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/jdwp, \ ! REPLACEMENTS := \ ! </body> => $(SPECS_BOTTOM_1)</body>, \ )) ! JDK_SPECS_TARGETS += $(PROCESS_JDWP_PROTOCOL) # 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 SetupTextFileProcessing, PROCESS_JVMTI_HTML, \ ! SOURCE_FILES := $(JVMTI_HTML), \ ! OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \ ! REPLACEMENTS := \ ! </body> => $(SPECS_BOTTOM_0)</body>, \ )) ! JDK_SPECS_TARGETS += $(PROCESS_JVMTI_HTML) ################################################################################ # Optional target which bundles all generated javadocs into a zip archive. JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip --- 578,600 ---- endif # Special treatment for generated documentation JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html ! $(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \ ! FILES := $(JDWP_PROTOCOL), \ ! DEST := $(DOCS_OUTPUTDIR)/specs/jdwp, \ )) ! JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL) # 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, \ ! FILES := $(JVMTI_HTML), \ ! DEST := $(DOCS_OUTPUTDIR)/specs, \ )) ! JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML) ################################################################################ # Optional target which bundles all generated javadocs into a zip archive. JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
*** 666,679 **** )) ZIP_TARGETS += $(BUILD_JAVADOC_ZIP) ################################################################################ - # Hook to include the corresponding custom file, if present. - $(eval $(call IncludeCustomExtension, Docs-post.gmk)) - - ################################################################################ docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) $(JDK_API_CUSTOM_TARGETS) docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS) --- 608,617 ----
< prev index next >