annotate make/Javadoc.gmk @ 44733:6505f00be6f2

8178038: Copy jdwp-protocol.html to proper location 8178039: Copy jvmti.html to proper location 8178316: Add JVM-MANAGEMENT-MIB.mib to jdk/src/java.management/share/specs/ Reviewed-by: erikj, mchung
author ihse
date Sun, 23 Apr 2017 21:10:32 +0200
parents c43bf5c360d5
children 70bbd6884287
rev   line source
ihse@43047 1 # Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
ohair@13697 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@13697 3 #
ohair@13697 4 # This code is free software; you can redistribute it and/or modify it
ohair@13697 5 # under the terms of the GNU General Public License version 2 only, as
ohair@13697 6 # published by the Free Software Foundation. Oracle designates this
ohair@13697 7 # particular file as subject to the "Classpath" exception as provided
ohair@13697 8 # by Oracle in the LICENSE file that accompanied this code.
ohair@13697 9 #
ohair@13697 10 # This code is distributed in the hope that it will be useful, but WITHOUT
ohair@13697 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@13697 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@13697 13 # version 2 for more details (a copy is included in the LICENSE file that
ohair@13697 14 # accompanied this code).
ohair@13697 15 #
ohair@13697 16 # You should have received a copy of the GNU General Public License version
ohair@13697 17 # 2 along with this work; if not, write to the Free Software Foundation,
ohair@13697 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@13697 19 #
ohair@13697 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@13697 21 # or visit www.oracle.com if you need additional information or have any
ohair@13697 22 # questions.
ohair@13697 23 #
ohair@13697 24
ihse@41652 25 default: all
ihse@41652 26
ohair@13697 27 include $(SPEC)
ohair@13697 28 include MakeBase.gmk
ihse@44725 29 include Modules.gmk
ihse@44725 30 include ZipArchive.gmk
chegar@43285 31 include $(JDK_TOPDIR)/make/Tools.gmk
mchung@44397 32 include $(JDK_TOPDIR)/make/ModuleTools.gmk
ohair@13697 33
ihse@44725 34 # This is needed to properly setup DOCS_MODULES.
ihse@44725 35 $(eval $(call ReadImportMetaData))
ihse@44725 36
ihse@41652 37 ################################################################################
ihse@44725 38 # Javadoc settings
ohair@13697 39
ihse@44725 40 # On top of the sources that was used to compile the JDK, we need some
ihse@44725 41 # extra java.rmi sources that are used just for javadoc.
ihse@44726 42 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
ihse@44725 43 $(SUPPORT_OUTPUTDIR)/rmic/* $(JDK_TOPDIR)/src/*/share/doc/stub)
alanb@36506 44
ihse@41652 45 # Should we use -Xdocrootparent? Allow custom to overwrite.
ihse@41652 46 DOCROOTPARENT_FLAG = TRUE
neugens@37034 47
ihse@41652 48 # URLs
ihse@41652 49 JAVADOC_BASE_URL := http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs
ihse@41652 50 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
ihse@44725 51 COPYRIGHT_URL := {@docroot}/../legal/cpyr.html
ihse@41652 52
ihse@42135 53 # In order to get a specific ordering it's necessary to specify the total
ihse@42135 54 # ordering of tags as the tags are otherwise ordered in order of definition.
ihse@44725 55 JAVADOC_TAGS := \
ihse@42135 56 -tag beaninfo:X \
ihse@42135 57 -tag revised:X \
ihse@42135 58 -tag since.unbundled:X \
ihse@42135 59 -tag spec:X \
ihse@42135 60 -tag specdefault:X \
ihse@42135 61 -tag Note:X \
ihse@42135 62 -tag ToDo:X \
ihse@42135 63 -tag 'apiNote:a:API Note:' \
ihse@42135 64 -tag 'implSpec:a:Implementation Requirements:' \
ihse@42135 65 -tag 'implNote:a:Implementation Note:' \
ihse@42135 66 -tag param \
ihse@42135 67 -tag return \
ihse@42135 68 -tag throws \
mchung@44397 69 -taglet build.tools.taglet.ModuleGraph \
ihse@42135 70 -tag since \
ihse@42135 71 -tag version \
ihse@42135 72 -tag serialData \
ihse@42135 73 -tag factory \
ihse@42135 74 -tag see \
ihse@42135 75 -tag 'jvms:a:See <cite>The Java&trade; Virtual Machine Specification</cite>:' \
ihse@42135 76 -tag 'jls:a:See <cite>The Java&trade; Language Specification</cite>:' \
chegar@43285 77 -taglet build.tools.taglet.Incubating \
chegar@43285 78 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
ihse@42135 79 #
ihse@42135 80
ihse@44725 81 # Which doclint checks to ignore
ihse@44725 82 JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference
ihse@44725 83
ihse@44725 84 # The initial set of options for javadoc
ihse@44725 85 JAVADOC_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \
ihse@44725 86 -serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \
ihse@44732 87 -html5 --expand-requires transitive
ihse@41652 88
ihse@44725 89 # Should we add DRAFT stamps to the generated javadoc?
ihse@44725 90 ifeq ($(VERSION_IS_GA), true)
ihse@44725 91 IS_DRAFT := false
ihse@44725 92 else
ihse@44725 93 IS_DRAFT := true
ihse@44725 94 endif
ohair@13697 95
ihse@41652 96 ################################################################################
ihse@44725 97 # General text snippets
alanb@36506 98
ihse@44725 99 FULL_COMPANY_NAME := Oracle and/or its affiliates
ihse@44725 100 COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA
ohair@13697 101
ihse@44725 102 ifeq ($(IS_DRAFT), true)
ihse@44725 103 DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong>
ihse@44725 104 ifeq ($(VERSION_BUILD), 0)
ihse@44725 105 DRAFT_MARKER_TITLE := [ad-hoc build]
ihse@44725 106 else
ihse@44725 107 DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)]
ihse@44725 108 endif
ihse@44725 109 endif
ihse@44725 110
ihse@44725 111 JAVADOC_WINDOW_TITLE := Java Platform SE $(VERSION_SPECIFICATION) \
ihse@44725 112 $(DRAFT_MARKER_TITLE)
ohair@13697 113
ihse@44725 114 JAVADOC_HEADER_TITLE := $(subst $(SPACE),&nbsp;,$(strip \
ihse@44725 115 <strong>Java&trade; Platform<br>Standard Ed. \
ihse@44725 116 $(VERSION_SPECIFICATION)</strong>$(DRAFT_MARKER_STR)))
ihse@44725 117
ihse@44725 118 JAVADOC_BOTTOM := \
ihse@44725 119 <span style="font-size:smaller"> \
ihse@44725 120 <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a><br> \
ihse@44725 121 For further API reference and developer documentation, see \
ihse@44725 122 <a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \
ihse@44725 123 Documentation</a>. That documentation contains more detailed, \
ihse@44725 124 developer-targeted descriptions, with conceptual overviews, definitions \
ihse@44725 125 of terms, workarounds, and working code examples.<br> \
ihse@44725 126 Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \
ihse@44725 127 the US and other countries.<br> \
ihse@44725 128 <a href="$(COPYRIGHT_URL)">Copyright</a> \
ihse@44725 129 &copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME). \
ihse@44725 130 $(COMPANY_ADDRESS). All rights reserved.$(DRAFT_MARKER_STR)</span>
ihse@44725 131
ihse@44725 132 JAVADOC_TOP := \
ihse@44725 133 <div style="background-color: $(HASH)EEEEEE"><div style="padding: 6px; \
ihse@44725 134 margin-top: 2px; margin-bottom: 6px; margin-left: 6px; margin-right: \
ihse@44725 135 6px; text-align: justify; font-size: 80%; font-family: Helvetica, Arial, \
ihse@44725 136 sans-serif; font-weight: normal;">Please note that the specifications \
ihse@44725 137 and other information contained herein are not final and are subject to \
ihse@44725 138 change. The information is being made available to you solely for \
ihse@44725 139 purpose of evaluation.</div></div>
ksrini@35367 140
ihse@41652 141 ################################################################################
ihse@44726 142 # JDK javadoc titles/text snippets
ksrini@35367 143
ihse@44726 144 JDK_JAVADOC_DOC_TITLE := Java&trade; Platform, Standard Edition Development Kit \
ihse@44726 145 (JDK&trade;) $(VERSION_SPECIFICATION)<br>API Specification
ihse@44726 146
ihse@44726 147 ################################################################################
ihse@44726 148 # Java SE javadoc titles/text snippets
ihse@44726 149
ihse@44726 150 JAVASE_JAVADOC_DOC_TITLE := Java&trade; Platform, Standard Edition \
ihse@44725 151 $(VERSION_SPECIFICATION)<br>API Specification
ksrini@35367 152
ihse@41652 153 ################################################################################
ihse@44726 154 # Functions
alanb@36506 155
ihse@44726 156 # Helper function for creating a png file from a dot file generated by the
ihse@44726 157 # GenGraphs tool.
ihse@44726 158 # param 1: SetupJavadocGeneration namespace ($1)
ihse@44726 159 # param 2: module name
ihse@44726 160 #
ihse@44726 161 define setup_gengraph_dot_to_png
ihse@44726 162 $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot
ihse@44726 163 $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2-graph.png
ksrini@35367 164
ihse@44726 165 # For each module needing a graph, create a png file from the dot file
ihse@44726 166 # generated by the GenGraphs tool and store it in the target dir.
ihse@44726 167 $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER)
ihse@44726 168 $$(call MakeDir, $$(@D))
ihse@44726 169 $$(call ExecuteWithLog, $$($1_$2_DOT_SRC), \
ihse@44726 170 $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC))
ihse@44725 171
ihse@44726 172 $1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET)
ihse@44726 173 endef
ksrini@35367 174
ihse@41652 175 ################################################################################
ihse@44726 176 # Setup make rules for creating the API documentation, using javadoc and other
ihse@44726 177 # tools if needed.
ihse@44726 178 #
ihse@44726 179 # Parameter 1 is the name of the rule. This name is used as variable prefix.
ihse@44726 180 # Targets generated are returned as $1_JAVADOC_TARGETS and
ihse@44726 181 # $1_MODULEGRAPH_TARGETS. Note that the index.html file will work as a "touch
ihse@44726 182 # file" for all the magnitude of files that are generated by javadoc.
ihse@44726 183 #
ihse@44726 184 # Remaining parameters are named arguments. These include:
ihse@44726 185 # MODULES - Modules to generate javadoc for
ihse@44726 186 # NAME - The name of the javadoc compilation, to be presented to the user
ihse@44726 187 # TARGET_DIR - Where to store the output
ihse@44726 188 # OVERVIEW - Path to an html overview file
ihse@44726 189 # DOC_TITLE - Title to use in -doctitle.
ihse@44726 190 # WINDOW_TITLE - Title to use in -windowtitle.
ihse@44726 191 # HEADER_TITLE - Title to use in -header.
ihse@44726 192 # BOTTOM_TEXT - Text to use in -bottom.
ihse@44726 193 # TOP_TEXT - Text to use in -top.
ihse@44726 194 #
ihse@44726 195 SetupApiDocsGeneration = $(NamedParamsMacroTemplate)
ihse@44726 196 define SetupApiDocsGenerationBody
ksrini@35367 197
ihse@44726 198 # Figure out all modules, both specified and transitive, that will be processed
ihse@44726 199 # by javadoc.
ihse@44726 200 $1_TRANSITIVE_MODULES := $$(call FindTransitiveDepsForModules, $$($1_MODULES))
ihse@44726 201 $1_ALL_MODULES := $$(sort $$($1_MODULES) $$($1_TRANSITIVE_MODULES))
ksrini@35367 202
ihse@44726 203 ifeq ($$(ENABLE_FULL_DOCS), true)
ihse@44726 204 # Tell the ModuleGraph taglet to generate html links to soon-to-be-created
ihse@44726 205 # png files with module graphs.
ihse@44726 206 $1_JAVA_ARGS += -DenableModuleGraph=true
ihse@44726 207 endif
ihse@44725 208
ihse@44726 209 # Always include tags and basic options
ihse@44726 210 $1_OPTIONS := $$(JAVADOC_TAGS) $$(JAVADOC_OPTIONS)
ihse@44725 211
ihse@44726 212 $1_OPTIONS += -overview $$($1_OVERVIEW)
ihse@44726 213 $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH)
ihse@44726 214 $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES))
ihse@44725 215
ihse@44726 216 # Create a string like "-Xdoclint:all,-syntax,-html,..."
ihse@44726 217 $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \
ihse@44726 218 $$(JAVADOC_DISABLED_DOCLINT)))
ihse@44726 219
ihse@44726 220 ifneq ($$($$DOCROOTPARENT_FLAG), )
ihse@44726 221 $1_OPTIONS += -Xdocrootparent $$(JAVADOC_BASE_URL)
ihse@44726 222 endif
ihse@44726 223
ihse@44726 224 $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)'
ihse@44726 225 $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)'
ihse@44726 226 $1_OPTIONS += -header '$$($1_HEADER_TITLE)'
ihse@44726 227 $1_OPTIONS += -bottom '$$($1_BOTTOM_TEXT)'
ihse@44726 228 ifeq ($$(IS_DRAFT), true)
ihse@44726 229 $1_OPTIONS += -top '$$($1_TOP_TEXT)'
ihse@44726 230 endif
ihse@44726 231
ihse@44726 232 # Do not store debug level options in VARDEPS.
ihse@44726 233 ifneq ($$(LOG_LEVEL), trace)
ihse@44726 234 $1_LOG_OPTION += -quiet
ihse@44726 235 else
ihse@44726 236 $1_LOG_OPTION += -verbose
ihse@44726 237 endif
ihse@44726 238
ihse@44726 239 $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \
ihse@44726 240 $$($1_ALL_MODULES)
ihse@44726 241 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
ihse@44726 242 $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps)
ihse@44726 243
ihse@44726 244 # Get a list of all files in all the source dirs for all included modules
ihse@44726 245 $1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \
ihse@44726 246 $$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module)))))
ihse@44726 247
ihse@44726 248 # Javadoc creates a lot of files but use index.html as a marker
ihse@44726 249 $$($1_TARGET_DIR)/index.html: $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) \
ihse@44726 250 $$($1_SOURCE_DEPS) $$($1_OVERVIEW)
ihse@44726 251 $$(call LogWarn, Generating $$($1_NAME) API javadoc for \
ihse@44726 252 $$(words $$($1_ALL_MODULES)) modules)
ihse@44726 253 $$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES))
ihse@44726 254 $$(call MakeDir, $$($1_TARGET_DIR))
ihse@44726 255 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \
ihse@44726 256 $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \
ihse@44726 257 $$(NEW_JAVADOC) -d $$($1_TARGET_DIR) \
ihse@44726 258 $$(JAVADOC_TAGS) $$($1_OPTIONS) $$($1_LOG_OPTION))
ihse@44726 259
ihse@44726 260 $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html
ihse@44726 261
ihse@44726 262 ifeq ($$(ENABLE_FULL_DOCS), true)
ihse@44726 263 # We have asked ModuleGraph to generate links to png files. Now we must
ihse@44726 264 # produce the png files.
ihse@44726 265
ihse@44726 266 # Locate which modules has the @moduleGraph tag in their module-info.java
ihse@44726 267 $1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \
ihse@44726 268 $$(if $$(shell $$(GREP) -e @moduleGraph \
ihse@44726 269 $$(wildcard $$(addsuffix /module-info.java, \
ihse@44726 270 $$(call FindModuleSrcDirs, $$m)))), \
ihse@44726 271 $$m) \
ihse@44726 272 ))
ihse@44726 273
ihse@44726 274 # First we run the GenGraph tool. It will query the module structure of the
ihse@44726 275 # running JVM and output .dot files for all existing modules.
ihse@44726 276 GENGRAPHS_PROPS := \
ihse@44726 277 $$(JDK_TOPDIR)/make/src/classes/build/tools/jigsaw/javadoc-graphs.properties
ihse@44726 278
ihse@44726 279 $1_GENGRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-gengraphs
ihse@44726 280 $1_GENGRAPHS_MARKER := $$($1_GENGRAPHS_DIR)/_gengraphs_run.marker
ihse@44726 281
ihse@44726 282 $$($1_GENGRAPHS_MARKER): $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS)
ihse@44726 283 $$(call LogInfo, Running gengraphs for $$($1_NAME) API documentation)
ihse@44726 284 $$(call MakeDir, $$($1_GENGRAPHS_DIR))
ihse@44726 285 $$(call ExecuteWithLog, $$($1_GENGRAPHS_DIR)/gengraphs, \
ihse@44726 286 $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \
ihse@44726 287 --dot-attributes $$(GENGRAPHS_PROPS) && \
ihse@44726 288 $$(TOUCH) $$($1_GENGRAPHS_MARKER))
ihse@44726 289
ihse@44726 290 # For each module needing a graph, create a png file from the dot file
ihse@44726 291 # generated by the GenGraphs tool and store it in the target dir.
ihse@44726 292 # They will depend on $1_GENGRAPHS_MARKER, and will be added to $1.
ihse@44726 293 $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \
ihse@44726 294 $$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \
ihse@44726 295 )
ihse@44726 296 endif
ihse@44726 297 endef
ihse@44726 298
ihse@44726 299 ################################################################################
ihse@44726 300 # Setup generation of the JDK API documentation (javadoc + modulegraph)
ihse@44726 301
ihse@44726 302 # All modules to have docs generated by docs-jdk-api target
ihse@44726 303 JDK_JAVADOC_MODULES := $(sort $(DOCS_MODULES))
ihse@44726 304
ihse@44726 305 JDK_JAVADOC_OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html
ihse@44726 306
ihse@44726 307 $(eval $(call SetupApiDocsGeneration, JDK_API, \
ihse@44726 308 MODULES := $(JDK_JAVADOC_MODULES), \
ihse@44726 309 NAME := JDK, \
ihse@44726 310 TARGET_DIR := $(JAVADOC_OUTPUTDIR)/api, \
ihse@44726 311 OVERVIEW := $(JDK_JAVADOC_OVERVIEW), \
ihse@44726 312 DOC_TITLE := $(JDK_JAVADOC_DOC_TITLE), \
ihse@44726 313 WINDOW_TITLE := $(JAVADOC_WINDOW_TITLE), \
ihse@44726 314 HEADER_TITLE := $(JAVADOC_HEADER_TITLE), \
ihse@44726 315 BOTTOM_TEXT := $(JAVADOC_BOTTOM), \
ihse@44726 316 TOP_TEXT := $(JAVADOC_TOP), \
ihse@44726 317 ))
ihse@44726 318
ihse@44726 319 # Targets generated are returned in JDK_API_JAVADOC_TARGETS and
ihse@44726 320 # JDK_API_MODULEGRAPH_TARGETS.
ihse@44726 321
ihse@44726 322 ################################################################################
ihse@44726 323 # Setup generation of the Java SE API documentation (javadoc + modulegraph)
ihse@44726 324
ihse@44726 325 # The Java SE module scope is just java.se.ee and it's transitive modules.
ihse@44726 326 JAVASE_JAVADOC_MODULES := java.se.ee
ihse@44726 327
ihse@44726 328 JAVASE_JAVADOC_OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html
ihse@44726 329
ihse@44726 330 $(eval $(call SetupApiDocsGeneration, JAVASE_API, \
ihse@44726 331 MODULES := $(JAVASE_JAVADOC_MODULES), \
ihse@44726 332 NAME := Java SE, \
ihse@44726 333 TARGET_DIR := $(IMAGES_OUTPUTDIR)/javase-docs/api, \
ihse@44726 334 OVERVIEW := $(JAVASE_JAVADOC_OVERVIEW), \
ihse@44726 335 DOC_TITLE := $(JAVASE_JAVADOC_DOC_TITLE), \
ihse@44726 336 WINDOW_TITLE := $(JAVADOC_WINDOW_TITLE), \
ihse@44726 337 HEADER_TITLE := $(JAVADOC_HEADER_TITLE), \
ihse@44726 338 BOTTOM_TEXT := $(JAVADOC_BOTTOM), \
ihse@44726 339 TOP_TEXT := $(JAVADOC_TOP), \
ihse@44726 340 ))
ihse@44726 341
ihse@44726 342 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
ihse@44726 343 # JAVASE_API_MODULEGRAPH_TARGETS.
ohair@13697 344
ihse@41652 345 ################################################################################
ihse@44733 346 # Copy JDK specs files
ihse@41652 347
ihse@44733 348 # For all html documentation in $module/share/specs directories, copy it
ihse@44733 349 # unmodified
ihse@41652 350
ihse@44733 351 ALL_MODULES := $(call FindAllModules)
ihse@44733 352 COPY_SPEC_FILTER := %.html %.gif %.jpg %.mib
ihse@44733 353
ihse@44733 354 $(foreach m, $(ALL_MODULES), \
ihse@44733 355 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
ihse@44733 356 $(if $(SPECS_$m), \
ihse@44733 357 $(eval $(call SetupCopyFiles, COPY_$m, \
ihse@44733 358 SRC := $(SPECS_$m), \
ihse@44733 359 FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $(SPECS_$m))), \
ihse@44733 360 DEST := $(JAVADOC_OUTPUTDIR)/specs/, \
ihse@44733 361 )) \
ihse@44733 362 $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
ihse@44733 363 ) \
ihse@44733 364 )
ihse@44733 365
ihse@44733 366 # Special treatment for generated documentation
ihse@44733 367
ihse@44733 368 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
ihse@44733 369 $(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \
ihse@44733 370 FILES := $(JDWP_PROTOCOL), \
ihse@44733 371 DEST := $(JAVADOC_OUTPUTDIR)/specs/jdwp, \
ihse@41652 372 ))
ihse@44733 373 JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL)
ihse@41652 374
ihse@44733 375 # Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical).
ihse@44733 376 JVMTI_HTML := $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
erikj@41260 377 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
erikj@41260 378 FILES := $(JVMTI_HTML), \
ihse@44733 379 DEST := $(JAVADOC_OUTPUTDIR)/specs, \
erikj@41260 380 ))
ihse@44733 381 JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML)
ohair@13697 382
ihse@41652 383 ################################################################################
ihse@41652 384 # Optional target which bundles all generated javadocs into a zip archive.
neugens@37034 385
ihse@44725 386 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
ihse@44725 387 JAVADOC_ZIP_FILE := $(OUTPUT_ROOT)/bundles/$(JAVADOC_ZIP_NAME)
ihse@41652 388
ihse@44725 389 $(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \
ihse@44733 390 SRC := $(JAVADOC_OUTPUTDIR), \
ihse@44733 391 ZIP := $(JAVADOC_ZIP_FILE), \
ihse@44733 392 EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \
ihse@44733 393 $(JDK_SPECS_TARGETS), \
ihse@44725 394 ))
neugens@37034 395
ihse@44725 396 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
erikj@39384 397
erikj@39384 398 ################################################################################
erikj@39384 399
ihse@41652 400 # Hook to include the corresponding custom file, if present.
ihse@41652 401 $(eval $(call IncludeCustomExtension, , Javadoc.gmk))
ihse@41652 402
ihse@41652 403 ################################################################################
ihse@41652 404
ihse@44726 405 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS)
mchung@44397 406
ihse@44726 407 docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS)
ihse@44725 408
ihse@44726 409 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS)
ihse@44726 410
ihse@44726 411 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
ihse@41652 412
ihse@44733 413 docs-jdk-specs: $(JDK_SPECS_TARGETS)
ihse@41652 414
ihse@41652 415 docs-zip: $(ZIP_TARGETS)
ihse@41652 416
ihse@44726 417 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
ihse@44733 418 docs-javase-api-modulegraph docs-jdk-specs docs-zip
ihse@41652 419
ihse@44726 420 .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
ihse@44733 421 docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs docs-zip