1 # Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 # 4 # This code is free software; you can redistribute it and/or modify it 5 # under the terms of the GNU General Public License version 2 only, as 6 # published by the Free Software Foundation. Oracle designates this 7 # particular file as subject to the "Classpath" exception as provided 8 # by Oracle in the LICENSE file that accompanied this code. 9 # 10 # This code is distributed in the hope that it will be useful, but WITHOUT 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 # version 2 for more details (a copy is included in the LICENSE file that 14 # accompanied this code). 15 # 16 # You should have received a copy of the GNU General Public License version 17 # 2 along with this work; if not, write to the Free Software Foundation, 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 # 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 # or visit www.oracle.com if you need additional information or have any 22 # questions. 23 # 24 25 include $(SPEC) 26 include MakeBase.gmk 27 28 ################################################################# 29 # 30 # CORE_PKGS environment variable has been moved to the following file 31 # 32 include CORE_PKGS.gmk 33 # 34 # Load environment variables for API package names that are not part of 35 # the Java SE platform 36 # 37 include NON_CORE_PKGS.gmk 38 39 40 .SUFFIXES: # Delete the default suffixes 41 .SUFFIXES: .java 42 43 # 44 # Definitions for directories 45 # 46 47 DOCSDIR := $(IMAGES_OUTPUTDIR)/docs 48 DOCSTMPDIR = $(SUPPORT_OUTPUTDIR)/docs 49 50 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs 51 52 BUILD_NUMBER=$(JDK_BUILD_NUMBER) 53 54 JAVADOC_CMD = $(JAVA) \ 55 -Djava.awt.headless=true \ 56 $(NEW_JAVADOC) 57 58 # Copyright year for beginning of Java and some of the apis 59 # (Needed when creating the javadocs) 60 FIRST_COPYRIGHT_YEAR = 1993 61 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005 62 MIRROR_FIRST_COPYRIGHT_YEAR = 2004 63 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993 64 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993 65 JDI_FIRST_COPYRIGHT_YEAR = 1999 66 JAAS_FIRST_COPYRIGHT_YEAR = 1998 67 JGSS_FIRST_COPYRIGHT_YEAR = 2000 68 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005 69 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005 70 MGMT_FIRST_COPYRIGHT_YEAR = 2003 71 ATTACH_FIRST_COPYRIGHT_YEAR = 2005 72 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006 73 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009 74 TRACING_FIRST_COPYRIGHT_YEAR = 2008 75 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005 76 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014 77 JNLP_FIRST_COPYRIGHT_YEAR = 1998 78 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007 79 JDKNET_FIRST_COPYRIGHT_YEAR = 2014 80 81 # Oracle name 82 FULL_COMPANY_NAME = Oracle and/or its affiliates 83 84 # Copyright address 85 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA. 86 87 # The trademark symbol 88 TRADEMARK = ™ 89 90 # Common copyright lines used 91 # The word "Copyright" might optionally be a link to the file cpyr.html. 92 # The first year of copyright may vary or not be available. 93 # The address to the company might be optional. 94 COMMA:= , 95 EMPTY:= 96 SPACE:=$(EMPTY) $(EMPTY) 97 COPYRIGHT_SYMBOL = &\#x00a9; 98 # Macro to construct the copyright line 99 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81) 100 define CopyrightLine # optionalurl optionalfirstyear optionaladdress 101 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \ 102 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\ 103 $(FULL_COMPANY_NAME). $3 All rights reserved. 104 endef 105 106 # Url to root of documents 107 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR) 108 109 # Url to copyright html file 110 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html 111 112 # Url to bug filing site 113 BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/ 114 115 # Common line for how to submit a bug or rfe 116 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> 117 118 # Url to devdocs page 119 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html 120 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html 121 DEV_DOCS_URL-8 = http://download.oracle.com/javase/8/docs/index.html 122 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION)) 123 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs 124 125 # Common Java trademark line 126 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \ 127 $(FULL_COMPANY_NAME) in the US and other countries. 128 129 ################################################################# 130 # Macros: 131 132 133 # List of all possible directories for javadoc to look for sources 134 # NOTE: Quotes are required around sourcepath argument only on Windows. 135 # Otherwise, you get "No packages or classes specified." due 136 # to $(PATH_SEP) being interpreted as an end of 137 # command (newline or shell ; character) 138 ALL_SOURCE_DIRS := $(wildcard \ 139 $(JDK_TOPDIR)/src/*/share/classes \ 140 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ 141 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ 142 $(LANGTOOLS_TOPDIR)/src/*/share/classes \ 143 $(NASHORN_TOPDIR)/src/*/share/classes \ 144 $(CORBA_TOPDIR)/src/*/share/classes \ 145 $(JAXP_TOPDIR)/src/*/share/classes \ 146 $(JAXWS_TOPDIR)/src/*/share/classes \ 147 $(SUPPORT_OUTPUTDIR)/gensrc/j* \ 148 $(SUPPORT_OUTPUTDIR)/rmic/j* \ 149 $(JDK_TOPDIR)/src/*/share/doc/stub \ 150 ) \ 151 # 152 153 # List with classpath separator between them 154 EMPTY:= 155 SPACE:= $(EMPTY) $(EMPTY) 156 RELEASEDOCS_SOURCEPATH = \ 157 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS))) 158 159 define prep-target 160 $(MKDIR) -p $(@D) 161 $(RM) $@ 162 endef 163 164 # Prep for javadoc creation, assumes $@ is an index.html file 165 define prep-javadoc 166 @if [ -f "$@" -a "$?" != "" ] ; then \ 167 $(ECHO) "# Dependencies have changed: $?"; \ 168 fi 169 $(RM) -r $(@D) 170 $(MKDIR) -p $(@D) 171 endef 172 173 $(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS))) 174 define PackageDependencies 175 $(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS))))) 176 endef 177 178 # Given a list of packages, add packages that exist to $@, print summary 179 define PackageFilter # packages 180 @if [ "$1" != "" ] ; then \ 181 for p in $1 ; do \ 182 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ 183 found="false"; \ 184 for cp in $(ALL_SOURCE_DIRS) ; do \ 185 if [ -d $${cp}/$${pd} ] ; then \ 186 $(ECHO) "$${p}" >> $@; \ 187 found="true"; \ 188 break; \ 189 fi; \ 190 done; \ 191 if [ "$${found}" = "false" ] ; then \ 192 $(ECHO) "WARNING: Package not found: $${p}"; \ 193 fi; \ 194 done; \ 195 fi 196 endef 197 198 # Print out a summary of the javadoc command about to be run 199 define JavadocSummary # optionsfile packagesfile 200 @$(ECHO) "# Running javadoc for $(patsubst $(OUTPUT_ROOT)/%,%,$@)" $(LOG_WARN) 201 @($(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1) $(LOG_DEBUG) 202 @($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2) $(LOG_DEBUG) 203 endef 204 205 # 206 # Different api directories created from root directory 207 # 208 COREAPI_DOCSDIR = $(DOCSDIR)/api 209 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api 210 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api 211 PLATFORM_DOCSDIR = $(DOCSDIR)/platform 212 213 # The non-core api javadocs need to be able to access the root of the core 214 # api directory, so for jdk/api or jre/api to get to the core api/ 215 # directory we would use this: 216 JDKJRE2COREAPI = ../../api 217 218 # Common bottom argument 219 define CommonBottom # year 220 <font size="-1"><br> $(call CopyrightLine,,$1,)</font> 221 endef 222 223 # Common trademark bottom argument (Not sure why this is used sometimes) 224 define CommonTrademarkBottom # year 225 <font size="-1">\ 226 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\ 227 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\ 228 </font> 229 endef 230 231 # Common echo of option 232 define OptionOnly # opt 233 if [ "$1" != "" ] ; then \ 234 $(PRINTF) "%s\n" "$1"; \ 235 fi 236 endef 237 238 define OptionPair # opt arg 239 $(PRINTF) "%s '%s'\n" "$1" '$2' 240 endef 241 242 define OptionTrip # opt arg arg 243 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3' 244 endef 245 246 # Core api bottom argument (with special sauce) 247 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\ 248 <br>For further API reference and developer documentation, \ 249 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \ 250 That documentation contains more detailed, developer-targeted descriptions, \ 251 with conceptual overviews, definitions of terms, workarounds, \ 252 and working code examples.<br>\ 253 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\ 254 </font> 255 256 # Common javadoc options used by all bundles 257 258 ifdef OPENJDK 259 ADDITIONAL_JAVADOCFLAGS = \ 260 -Xdocrootparent $(DOCS_BASE_URL) 261 else 262 ADDITIONAL_JAVADOCFLAGS = 263 endif 264 265 define COMMON_JAVADOCFLAGS 266 $(call OptionOnly,-XDignore.symbol.file=true) ; \ 267 $(call OptionOnly,-quiet) ; \ 268 $(call OptionOnly,-use) ; \ 269 $(call OptionOnly,-keywords) ; \ 270 $(call OptionOnly,$(ADDITIONAL_JAVADOCFLAGS)) 271 endef 272 273 # Common javadoc tags used by all bundles 274 275 # Java language specification cite 276 TAG_JLS = jls:a:See <cite> \ 277 The Java™ Language Specification</cite>: 278 279 # Java virtual machine specification cite 280 TAG_JVMS = jvms:a:See <cite> \ 281 The Java™ Virtual Machine Specification</cite>: 282 283 # In order to get a specific ordering it's necessary to specify the total 284 # ordering of tags as the tags are otherwise ordered in order of definition. 285 define COMMON_JAVADOCTAGS 286 $(call OptionPair,-tag,beaninfo:X) ; \ 287 $(call OptionPair,-tag,revised:X) ; \ 288 $(call OptionPair,-tag,since.unbundled:X) ; \ 289 $(call OptionPair,-tag,spec:X) ; \ 290 $(call OptionPair,-tag,specdefault:X) ; \ 291 $(call OptionPair,-tag,Note:X) ; \ 292 $(call OptionPair,-tag,ToDo:X) ; \ 293 $(call OptionPair,-tag,apiNote:a:API Note:) ; \ 294 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \ 295 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \ 296 $(call OptionPair,-tag,param) ; \ 297 $(call OptionPair,-tag,return) ; \ 298 $(call OptionPair,-tag,throws) ; \ 299 $(call OptionPair,-tag,since) ; \ 300 $(call OptionPair,-tag,version) ; \ 301 $(call OptionPair,-tag,serialData) ; \ 302 $(call OptionPair,-tag,factory) ; \ 303 $(call OptionPair,-tag,see) ; \ 304 $(call OptionPair,-tag,$(TAG_JVMS)) ; \ 305 $(call OptionPair,-tag,$(TAG_JLS)) 306 endef 307 308 309 310 # Draft used for non-fcs documents 311 DRAFT_HEADER = 312 ifneq ($(MILESTONE), fcs) 313 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> 314 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> 315 DRAFT_WINTITLE = $(BUILD_NUMBER) 316 # Early access top text (not used in FCS releases) 317 COREAPI_TOP_EARLYACCESS = \ 318 <div style="background-color: \#EEEEEE"> \ 319 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ 320 margin-left: 6px; margin-right: 6px; text-align: justify; \ 321 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ 322 font-weight: normal;"> \ 323 Please note that the specifications and other information \ 324 contained herein are not final and are subject to change. \ 325 The information is being made available to you solely for purpose of \ 326 evaluation. \ 327 </div> </div> 328 329 endif 330 331 ################################################################# 332 333 # 334 # Load custom Javadoc rules 335 # 336 337 $(eval $(call IncludeCustomExtension, , Javadoc.gmk)) 338 339 ################################################################# 340 341 # 342 # Default target is same as docs target, create core api and all others it can 343 # 344 345 all: docs 346 docs: coredocs otherdocs 347 348 ################################################################# 349 # Production Targets -- USE THESE TARGETS WHEN: 350 # a) You're generating docs outside of release engineering's 351 # standard control build. 352 # b) The docs will be pushed to the web and/or included in 353 # the downloaded doc bundle. 354 # 355 # See: Notes.html#releaseTargets 356 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!) 357 # 358 359 sanitycheckcoredocs: 360 @$(ECHO) "" 361 @$(ECHO) "Building core api docs with these values:" 362 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)" 363 @$(ECHO) " MILESTONE = $(MILESTONE)" 364 @$(ECHO) "" 365 ifeq ($(BUILD_NUMBER), b00) 366 @$(ECHO) "ERROR: Build number must be defined" 367 @$(ECHO) "MILESTONE is set to $(MILESTONE)" 368 @$(ECHO) "" 369 exit 1 370 endif 371 372 ############################################################# 373 # 374 # coredocs 375 # 376 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \ 377 $(JDK_MINOR_VERSION)<br>API Specification 378 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION) 379 COREAPI_HEADER = \ 380 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong> 381 382 # Overview file for core apis 383 COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html 384 385 # The index.html, options, and packages files 386 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html 387 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options 388 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages 389 390 coredocs: $(COREAPI_INDEX_FILE) 391 392 # Set relative location to core api document root 393 $(COREAPI_INDEX_FILE): GET2DOCSDIR=.. 394 395 # Run javadoc if the index file is out of date or missing 396 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE) 397 $(prep-javadoc) 398 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE)) 399 $(JAVADOC_CMD) -d $(@D) \ 400 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE) 401 402 # Create file with javadoc options in it 403 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW) 404 $(prep-target) 405 @($(call COMMON_JAVADOCFLAGS) ; \ 406 $(call COMMON_JAVADOCTAGS) ; \ 407 $(call OptionOnly,-Xdoclint:none) ; \ 408 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 409 $(call OptionPair,-encoding,ISO-8859-1) ; \ 410 $(call OptionOnly,-splitIndex) ; \ 411 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \ 412 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \ 413 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \ 414 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \ 415 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 416 ) >> $@ 417 ifdef COREAPI_TOP_EARLYACCESS 418 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@ 419 endif 420 421 # Create a file with the package names in it 422 $(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS)) 423 $(prep-target) 424 $(call PackageFilter,$(CORE_PKGS)) 425 426 ############################################################# 427 # 428 # docletapidocs 429 # 430 431 ALL_OTHER_TARGETS += docletapidocs 432 433 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet 434 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) 435 DOCLETAPI_DOCTITLE := Doclet API 436 DOCLETAPI_WINDOWTITLE := Doclet API 437 DOCLETAPI_HEADER := <strong>Doclet API</strong> 438 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) 439 DOCLETAPI_GROUPNAME := Packages 440 DOCLETAPI_REGEXP := com.sun.javadoc 441 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk 442 443 # The index.html, options, and packages files 444 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html 445 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options 446 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages 447 448 docletapidocs: $(DOCLETAPI_INDEX_FILE) 449 450 # Set relative location to core api document root 451 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/.. 452 453 # Run javadoc if the index file is out of date or missing 454 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 455 $(prep-javadoc) 456 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE)) 457 $(JAVADOC_CMD) -d $(@D) \ 458 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE) 459 460 # Create file with javadoc options in it 461 $(DOCLETAPI_OPTIONS_FILE): 462 $(prep-target) 463 @($(call COMMON_JAVADOCFLAGS) ; \ 464 $(call COMMON_JAVADOCTAGS) ; \ 465 $(call OptionOnly,-Xdoclint:all) ; \ 466 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 467 $(call OptionPair,-encoding,ascii) ; \ 468 $(call OptionOnly,-breakiterator) ; \ 469 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \ 470 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 471 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ 472 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 473 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \ 474 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 475 ) >> $@ 476 477 # Create a file with the package names in it 478 $(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS)) 479 $(prep-target) 480 $(call PackageFilter,$(DOCLETAPI_PKGS)) 481 482 ############################################################# 483 # 484 # tagletapidocs 485 # 486 487 ALL_OTHER_TARGETS += tagletapidocs 488 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet 489 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) 490 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) 491 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk 492 493 # Temporary directory (special generation rules) 494 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp 495 496 # The index.html, options, and packages files 497 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html 498 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options 499 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages 500 501 tagletapidocs: $(TAGLETAPI_INDEX_FILE) 502 503 # Set relative location to core api document root 504 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/.. 505 506 # Run javadoc if the index file is out of date or missing 507 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 508 $(prep-javadoc) 509 $(RM) -r $(TAGLETAPI_TEMPDIR) 510 $(MKDIR) -p $(TAGLETAPI_TEMPDIR) 511 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) 512 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \ 513 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) 514 cp -r $(TAGLETAPI_TEMPDIR)/com $(TAGLETAPI_DOCDIR) 515 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(TAGLETAPI_DOCDIR) 516 $(RM) -r $(TAGLETAPI_TEMPDIR) 517 518 # Create file with javadoc options in it 519 $(TAGLETAPI_OPTIONS_FILE): 520 $(prep-target) 521 @($(call COMMON_JAVADOCFLAGS) ; \ 522 $(call COMMON_JAVADOCTAGS) ; \ 523 $(call OptionOnly,-Xdoclint:all) ; \ 524 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 525 $(call OptionPair,-encoding,ascii) ; \ 526 $(call OptionOnly,-nonavbar) ; \ 527 $(call OptionOnly,-noindex) ; \ 528 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 529 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 530 ) >> $@ 531 532 # Create a file with the package names in it 533 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS)) 534 $(prep-target) 535 @($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@ 536 537 ############################################################# 538 # 539 # domapidocs 540 # 541 542 ALL_OTHER_TARGETS += domapidocs 543 544 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom 545 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) 546 DOMAPI_DOCTITLE := Common DOM API 547 DOMAPI_WINDOWTITLE := Common DOM API 548 DOMAPI_HEADER := <strong>Common DOM API</strong> 549 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) 550 DOMAPI_GROUPNAME := Packages 551 DOMAPI_REGEXP := org.w3c.dom* 552 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk 553 554 # The index.html, options, and packages files 555 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html 556 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options 557 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages 558 559 domapidocs: $(DOMAPI_INDEX_FILE) 560 561 # Set relative location to core api document root 562 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. 563 564 # Run javadoc if the index file is out of date or missing 565 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 566 $(prep-javadoc) 567 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) 568 $(JAVADOC_CMD) -d $(@D) \ 569 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) 570 571 # Create file with javadoc options in it 572 $(DOMAPI_OPTIONS_FILE): 573 $(prep-target) 574 @($(call COMMON_JAVADOCFLAGS) ; \ 575 $(call COMMON_JAVADOCTAGS) ; \ 576 $(call OptionOnly,-Xdoclint:none) ; \ 577 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 578 $(call OptionPair,-encoding,ascii) ; \ 579 $(call OptionOnly,-splitIndex) ; \ 580 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ 581 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 582 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ 583 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 584 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ 585 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 586 ) >> $@ 587 588 # Create a file with the package names in it 589 $(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS)) 590 $(prep-target) 591 $(call PackageFilter,$(DOMAPI_PKGS)) 592 593 ############################################################# 594 # 595 # jpdadocs 596 # 597 598 ALL_OTHER_TARGETS += jpdadocs 599 600 jpdadocs: jdidocs jdwpdocs jvmtidocs 601 602 ############################################################# 603 # 604 # jdidocs 605 # 606 607 ALL_OTHER_TARGETS += jdidocs 608 609 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi 610 JDI2COREAPI := ../../$(JDKJRE2COREAPI) 611 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface 612 JDI_WINDOWTITLE := Java Debug Interface 613 JDI_HEADER := <strong>Java Debug Interface</strong> 614 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) 615 JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html 616 # JDI_PKGS is located in NON_CORE_PKGS.gmk 617 618 # The index.html, options, and packages files 619 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html 620 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options 621 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages 622 623 jdidocs: $(JDI_INDEX_FILE) 624 625 # Set relative location to core api document root 626 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. 627 628 # Run javadoc if the index file is out of date or missing 629 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 630 $(prep-javadoc) 631 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) 632 $(JAVADOC_CMD) -d $(@D) \ 633 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) 634 635 # Create file with javadoc options in it 636 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) 637 $(prep-target) 638 @($(call COMMON_JAVADOCFLAGS) ; \ 639 $(call COMMON_JAVADOCTAGS) ; \ 640 $(call OptionOnly,-Xdoclint:none) ; \ 641 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 642 $(call OptionPair,-encoding,ascii) ; \ 643 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ 644 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ 645 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 646 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ 647 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 648 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ 649 ) >> $@ 650 651 # Create a file with the package names in it 652 $(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS)) 653 $(prep-target) 654 $(call PackageFilter,$(JDI_PKGS)) 655 656 ############################################################# 657 # 658 # jdwpdocs 659 # 660 661 ALL_OTHER_TARGETS += jdwpdocs 662 663 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp 664 665 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html 666 $(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html 667 $(MKDIR) -p $(@D) 668 $(RM) $@ 669 $(CP) $< $@ 670 671 ############################################################# 672 # 673 # jvmtidocs 674 # 675 676 ALL_OTHER_TARGETS += jvmtidocs 677 678 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti 679 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html 680 681 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html 682 $(JVMTI_DOCDIR)/jvmti.html: 683 @$(prep-javadoc) 684 @if [ -f $(JVMTI_HTML) ] ; then \ 685 $(CP) $(JVMTI_HTML) $@; \ 686 else \ 687 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \ 688 fi 689 690 ############################################################# 691 # 692 # jaasdocs 693 # 694 695 ALL_OTHER_TARGETS += jaasdocs 696 697 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec 698 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) 699 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service 700 JAAS_WINDOWTITLE := Java Authentication and Authorization Service 701 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> 702 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) 703 # JAAS_PKGS is located in NON_CORE_PKGS.gmk 704 JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html 705 706 # The index.html, options, and packages files 707 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html 708 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options 709 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages 710 711 jaasdocs: $(JAAS_INDEX_FILE) 712 713 # Set relative location to core api document root 714 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. 715 716 # Run javadoc if the index file is out of date or missing 717 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 718 $(prep-javadoc) 719 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) 720 $(JAVADOC_CMD) -d $(@D) \ 721 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) 722 723 # Create file with javadoc options in it 724 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) 725 $(prep-target) 726 @($(call COMMON_JAVADOCFLAGS) ; \ 727 $(call COMMON_JAVADOCTAGS) ; \ 728 $(call OptionOnly,-Xdoclint:none) ; \ 729 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 730 $(call OptionPair,-encoding,ascii) ; \ 731 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ 732 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ 733 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 734 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ 735 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 736 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ 737 ) >> $@ 738 739 # Create a file with the package names in it 740 $(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS)) 741 $(prep-target) 742 $(call PackageFilter,$(JAAS_PKGS)) 743 744 ############################################################# 745 # 746 # jgssdocs 747 # 748 749 ALL_OTHER_TARGETS += jgssdocs 750 751 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec 752 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) 753 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities 754 JGSS_WINDOWTITLE := Java GSS-API Utilities 755 JGSS_HEADER := <strong>Java GSS-API Utilities</strong> 756 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) 757 JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html 758 # JGSS_PKGS is located in NON_CORE_PKGS.gmk 759 760 # The index.html, options, and packages files 761 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html 762 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options 763 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages 764 765 jgssdocs: $(JGSS_INDEX_FILE) 766 767 # Set relative location to core api document root 768 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. 769 770 # Run javadoc if the index file is out of date or missing 771 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 772 $(prep-javadoc) 773 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) 774 $(JAVADOC_CMD) -d $(@D) \ 775 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) 776 777 # Create file with javadoc options in it 778 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) 779 $(prep-target) 780 @($(call COMMON_JAVADOCFLAGS) ; \ 781 $(call COMMON_JAVADOCTAGS) ; \ 782 $(call OptionOnly,-Xdoclint:none) ; \ 783 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 784 $(call OptionPair,-encoding,ascii) ; \ 785 $(call OptionOnly,-nodeprecatedlist) ; \ 786 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ 787 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ 788 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 789 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ 790 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 791 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ 792 ) >> $@ 793 794 # Create a file with the package names in it 795 $(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS)) 796 $(prep-target) 797 $(call PackageFilter,$(JGSS_PKGS)) 798 799 ############################################################# 800 # 801 # smartcardiodocs 802 # 803 804 ALL_OTHER_TARGETS += smartcardiodocs 805 806 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec 807 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) 808 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O 809 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O 810 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> 811 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) 812 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk 813 814 # The index.html, options, and packages files 815 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html 816 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options 817 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages 818 819 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) 820 821 # Set relative location to core api document root 822 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. 823 824 # Run javadoc if the index file is out of date or missing 825 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 826 $(prep-javadoc) 827 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) 828 $(JAVADOC_CMD) -d $(@D) \ 829 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) 830 831 # Create file with javadoc options in it 832 $(SMARTCARDIO_OPTIONS_FILE): 833 $(prep-target) 834 @($(call COMMON_JAVADOCFLAGS) ; \ 835 $(call COMMON_JAVADOCTAGS) ; \ 836 $(call OptionOnly,-Xdoclint:none) ; \ 837 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 838 $(call OptionPair,-encoding,ascii) ; \ 839 $(call OptionOnly,-nodeprecatedlist) ; \ 840 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ 841 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 842 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ 843 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ 844 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ 845 ) >> $@ 846 847 # Create a file with the package names in it 848 $(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS)) 849 $(prep-target) 850 $(call PackageFilter,$(SMARTCARDIO_PKGS)) 851 852 ############################################################# 853 # 854 # httpserverdocs 855 # 856 857 ALL_OTHER_TARGETS += httpserverdocs 858 859 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec 860 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) 861 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server 862 HTTPSERVER_WINDOWTITLE := Java HTTP Server 863 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> 864 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) 865 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk 866 867 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html 868 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options 869 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages 870 871 httpserverdocs: $(HTTPSERVER_INDEX_HTML) 872 873 # Set relative location to core api document root 874 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. 875 876 # Run javadoc if the index file is out of date or missing 877 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 878 $(prep-javadoc) 879 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) 880 $(JAVADOC_CMD) -d $(@D) \ 881 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) 882 883 # Create file with javadoc options in it 884 $(HTTPSERVER_OPTIONS_FILE): 885 $(prep-target) 886 @($(call COMMON_JAVADOCFLAGS) ; \ 887 $(call COMMON_JAVADOCTAGS) ; \ 888 $(call OptionOnly,-Xdoclint:none) ; \ 889 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 890 $(call OptionPair,-encoding,ascii) ; \ 891 $(call OptionOnly,-nodeprecatedlist) ; \ 892 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ 893 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 894 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ 895 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ 896 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ 897 ) >> $@ 898 899 # Create a file with the package names in it 900 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS)) 901 $(prep-target) 902 $(call PackageFilter,$(HTTPSERVER_PKGS)) 903 904 ############################################################# 905 # 906 # mgmtdocs 907 # 908 909 ALL_OTHER_TARGETS += mgmtdocs 910 911 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension 912 MGMT2COREAPI := ../../$(JDKJRE2COREAPI) 913 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib 914 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME) 915 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform 916 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform 917 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> 918 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) 919 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html 920 # MGMT_PKGS is located in NON_CORE_PKGS.gmk 921 922 # The index.html, options, and packages files 923 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html 924 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options 925 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages 926 927 mgmtdocs: $(MGMT_INDEX_FILE) 928 929 # Set relative location to core api document root 930 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. 931 932 # Run javadoc if the index file is out of date or missing 933 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 934 $(prep-javadoc) 935 @if [ -f $(JVM_MIB_SRC) ] ; then \ 936 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \ 937 else \ 938 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \ 939 fi 940 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) 941 $(JAVADOC_CMD) -d $(@D) \ 942 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) 943 944 # Create file with javadoc options in it 945 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) 946 $(prep-target) 947 @($(call COMMON_JAVADOCFLAGS) ; \ 948 $(call COMMON_JAVADOCTAGS) ; \ 949 $(call OptionOnly,-Xdoclint:none) ; \ 950 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 951 $(call OptionPair,-encoding,ascii) ; \ 952 $(call OptionOnly,-nodeprecatedlist) ; \ 953 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ 954 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ 955 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 956 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ 957 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ 958 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ 959 ) >> $@ 960 961 # Create a file with the package names in it 962 $(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS)) 963 $(prep-target) 964 $(call PackageFilter,$(MGMT_PKGS)) 965 966 ############################################################# 967 # 968 # attachdocs 969 # 970 971 ALL_OTHER_TARGETS += attachdocs 972 973 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec 974 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) 975 ATTACH_DOCTITLE := Attach API 976 ATTACH_WINDOWTITLE := Attach API 977 ATTACH_HEADER := <strong>Attach API</strong> 978 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) 979 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk 980 981 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html 982 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options 983 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages 984 985 attachdocs: $(ATTACH_INDEX_HTML) 986 987 # Set relative location to core api document root 988 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. 989 990 # Run javadoc if the index file is out of date or missing 991 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 992 $(prep-javadoc) 993 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) 994 $(JAVADOC_CMD) -d $(@D) \ 995 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) 996 997 # Create file with javadoc options in it 998 $(ATTACH_OPTIONS_FILE): 999 $(prep-target) 1000 @($(call COMMON_JAVADOCFLAGS) ; \ 1001 $(call COMMON_JAVADOCTAGS) ; \ 1002 $(call OptionOnly,-Xdoclint:none) ; \ 1003 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1004 $(call OptionPair,-encoding,ascii) ; \ 1005 $(call OptionOnly,-nodeprecatedlist) ; \ 1006 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ 1007 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1008 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ 1009 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1010 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ 1011 ) >> $@ 1012 1013 # Create a file with the package names in it 1014 $(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS)) 1015 $(prep-target) 1016 $(call PackageFilter,$(ATTACH_PKGS)) 1017 1018 ############################################################# 1019 # 1020 # jconsoledocs 1021 # 1022 1023 ALL_OTHER_TARGETS += jconsoledocs 1024 1025 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec 1026 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) 1027 JCONSOLE_DOCTITLE := JConsole API 1028 JCONSOLE_WINDOWTITLE := JConsole API 1029 JCONSOLE_HEADER := <strong>JConsole API</strong> 1030 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) 1031 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk 1032 1033 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html 1034 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options 1035 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages 1036 1037 jconsoledocs: $(JCONSOLE_INDEX_HTML) 1038 1039 # Set relative location to core api document root 1040 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. 1041 1042 # Run javadoc if the index file is out of date or missing 1043 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1044 $(prep-javadoc) 1045 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) 1046 $(JAVADOC_CMD) -d $(@D) \ 1047 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) 1048 1049 # Create file with javadoc options in it 1050 $(JCONSOLE_OPTIONS_FILE): 1051 $(prep-target) 1052 @($(call COMMON_JAVADOCFLAGS) ; \ 1053 $(call COMMON_JAVADOCTAGS) ; \ 1054 $(call OptionOnly,-Xdoclint:none) ; \ 1055 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1056 $(call OptionPair,-encoding,ascii) ; \ 1057 $(call OptionOnly,-nodeprecatedlist) ; \ 1058 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ 1059 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1060 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ 1061 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1062 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ 1063 ) >> $@ 1064 1065 # Create a file with the package names in it 1066 $(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS)) 1067 $(prep-target) 1068 $(call PackageFilter,$(JCONSOLE_PKGS)) 1069 1070 ############################################################# 1071 # 1072 # treeapidocs 1073 # 1074 1075 ALL_OTHER_TARGETS += treeapidocs 1076 1077 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree 1078 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1079 TREEAPI_DOCTITLE := Compiler Tree API 1080 TREEAPI_WINDOWTITLE := Compiler Tree API 1081 TREEAPI_HEADER := <strong>Compiler Tree API</strong> 1082 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) 1083 TREEAPI_GROUPNAME := Packages 1084 TREEAPI_REGEXP := com.sun.source.* 1085 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk 1086 1087 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html 1088 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options 1089 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages 1090 1091 treeapidocs: $(TREEAPI_INDEX_HTML) 1092 1093 # Set relative location to core api document root 1094 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. 1095 1096 # Run javadoc if the index file is out of date or missing 1097 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1098 $(prep-javadoc) 1099 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) 1100 $(JAVADOC_CMD) -d $(@D) \ 1101 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) 1102 1103 # Create file with javadoc options in it 1104 $(TREEAPI_OPTIONS_FILE): 1105 $(prep-target) 1106 @($(call COMMON_JAVADOCFLAGS) ; \ 1107 $(call COMMON_JAVADOCTAGS) ; \ 1108 $(call OptionOnly,-Xdoclint:all) ; \ 1109 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1110 $(call OptionPair,-encoding,ascii) ; \ 1111 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \ 1112 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1113 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \ 1114 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1115 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ 1116 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1117 ) >> $@ 1118 1119 # Create a file with the package names in it 1120 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS)) 1121 $(prep-target) 1122 $(call PackageFilter,$(TREEAPI_PKGS)) 1123 1124 ############################################################# 1125 # 1126 # nashornapidocs 1127 # 1128 1129 ALL_OTHER_TARGETS += nashornapidocs 1130 1131 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn 1132 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI) 1133 NASHORNAPI_DOCTITLE := Nashorn API 1134 NASHORNAPI_WINDOWTITLE := Nashorn API 1135 NASHORNAPI_HEADER := <strong>Nashorn API</strong> 1136 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR)) 1137 NASHORNAPI_GROUPNAME := Packages 1138 NASHORNAPI_REGEXP := jdk.nashorn.api.scripting.* 1139 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk 1140 1141 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html 1142 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options 1143 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages 1144 1145 nashornapidocs: $(NASHORNAPI_INDEX_HTML) 1146 1147 # Set relative location to core api document root 1148 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/.. 1149 1150 # Run javadoc if the index file is out of date or missing 1151 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1152 $(prep-javadoc) 1153 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE)) 1154 $(JAVADOC_CMD) -d $(@D) \ 1155 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE) 1156 1157 # Create file with javadoc options in it 1158 $(NASHORNAPI_OPTIONS_FILE): 1159 $(prep-target) 1160 @($(call COMMON_JAVADOCFLAGS) ; \ 1161 $(call COMMON_JAVADOCTAGS) ; \ 1162 $(call OptionOnly,-Xdoclint:all) ; \ 1163 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1164 $(call OptionPair,-encoding,ascii) ; \ 1165 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \ 1166 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1167 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \ 1168 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1169 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \ 1170 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1171 ) >> $@ 1172 1173 # Create a file with the package names in it 1174 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS)) 1175 $(prep-target) 1176 $(call PackageFilter,$(NASHORNAPI_PKGS)) 1177 1178 ############################################################# 1179 # 1180 # sctpdocs 1181 # 1182 1183 ALL_OTHER_TARGETS += sctpdocs 1184 1185 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec 1186 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1187 SCTPAPI_DOCTITLE := SCTP API 1188 SCTPAPI_WINDOWTITLE := SCTP API 1189 SCTPAPI_HEADER := <strong>SCTP API</strong> 1190 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) 1191 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk 1192 1193 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html 1194 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options 1195 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages 1196 1197 sctpdocs: $(SCTPAPI_INDEX_HTML) 1198 1199 # Set relative location to core api document root 1200 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. 1201 1202 # Run javadoc if the index file is out of date or missing 1203 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1204 $(prep-javadoc) 1205 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) 1206 $(JAVADOC_CMD) -d $(@D) \ 1207 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) 1208 1209 # Create file with javadoc options in it 1210 $(SCTPAPI_OPTIONS_FILE): 1211 $(prep-target) 1212 @($(call COMMON_JAVADOCFLAGS) ; \ 1213 $(call COMMON_JAVADOCTAGS) ; \ 1214 $(call OptionOnly,-Xdoclint:none) ; \ 1215 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1216 $(call OptionPair,-encoding,ascii) ; \ 1217 $(call OptionOnly,-nodeprecatedlist) ; \ 1218 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ 1219 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1220 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ 1221 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1222 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1223 ) >> $@ 1224 1225 # Create a file with the package names in it 1226 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS)) 1227 $(prep-target) 1228 $(call PackageFilter,$(SCTPAPI_PKGS)) 1229 1230 ############################################################# 1231 # 1232 # jdk.net docs 1233 # 1234 1235 ALL_OTHER_TARGETS += jdknetdocs 1236 1237 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec 1238 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI) 1239 JDKNET_DOCTITLE := jdk.net API 1240 JDKNET_WINDOWTITLE := jdk.net API 1241 JDKNET_HEADER := <strong>jdk.net API</strong> 1242 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR)) 1243 JDKNET_PKGS := jdk.net 1244 1245 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html 1246 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options 1247 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages 1248 1249 jdknetdocs: $(JDKNET_INDEX_HTML) 1250 1251 # Set relative location to core api document root 1252 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/.. 1253 1254 # Run javadoc if the index file is out of date or missing 1255 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1256 $(prep-javadoc) 1257 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE)) 1258 $(JAVADOC_CMD) -d $(@D) \ 1259 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE) 1260 1261 # Create file with javadoc options in it 1262 $(JDKNET_OPTIONS_FILE): 1263 $(prep-target) 1264 @($(call COMMON_JAVADOCFLAGS) ; \ 1265 $(call COMMON_JAVADOCTAGS) ; \ 1266 $(call OptionOnly,-Xdoclint:none) ; \ 1267 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1268 $(call OptionPair,-encoding,ascii) ; \ 1269 $(call OptionOnly,-nodeprecatedlist) ; \ 1270 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \ 1271 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1272 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \ 1273 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \ 1274 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \ 1275 ) >> $@ 1276 1277 # Create a file with the package names in it 1278 $(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS)) 1279 $(prep-target) 1280 $(call PackageFilter,$(JDKNET_PKGS)) 1281 1282 ############################################################# 1283 #release version of core packages ######## 1284 1285 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs 1286 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release 1287 # process. It specifies memory settings accordingly to maximize performance. 1288 # 1289 # The performance settings, like the sanity check, are most important for the core 1290 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount 1291 # of time and memory. Setting the initial heap size as large as possible is important 1292 # to prevent thrashing as the heap grows. Setting the maximum as large as necessary 1293 # is also important to keep the job from failing. 1294 # 1295 # -J-Xmx512 sets a maximum of 512, which became necessary in 6.0 1296 # -J-Xms256 sets starting size to 256 (default is 8) 1297 # 1298 # rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and 1299 # MILESTONE are specified properly when docs are built outside of the normal release 1300 # engineering process, with the intention of releasing them on the web or in a downloaded 1301 # docs bundle. (When invoked in release engineering's control build, the values are always 1302 # set properly. But when the targets are run by themselves, they default to b00 and 1303 # "internal"--which silently sabotage the result of a build that can take many hours 1304 # to complete. 1305 1306 # Maximize performance and ensure that build number & milestone are set. 1307 1308 rel-coredocs: sanitycheckcoredocs 1309 $(MAKE) coredocs 1310 1311 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS) 1312 # 1313 # end of production targets 1314 1315 otherdocs: $(ALL_OTHER_TARGETS) 1316 1317 clean: 1318 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR) 1319 1320 ############################################################# 1321 # DEBUG TARGET 1322 # List the values defined in the makefile hierarchy, to make sure everything 1323 # is set properly, and to help identify values we can use instead of making new ones. 1324 # (Most of them come from common/shared/Defs.gmk) 1325 # 1326 # Notes: 1327 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value> 1328 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line 1329 # 1330 1331 ############################################################# 1332 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \ 1333 sanitycheckcoredocs $(ALL_OTHER_TARGETS)