1 # Copyright (c) 1997, 2011, 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 # 26 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc. 27 # 28 BUILDDIR=.. 29 PRODUCT=docs 30 include $(BUILDDIR)/common/Defs.gmk 31 32 # Get CopyrightLine macro and other shared variables 33 include $(BUILDDIR)/common/shared/Defs-javadoc.gmk 34 35 # Url to root of documents 36 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR) 37 38 # Url to copyright html file 39 COPYRIGHT_URL-7 = $(DOCSDIR_URL)/legal/cpyr.html 40 COPYRIGHT_URL = $(COPYRIGHT_URL-$(JDK_MINOR_VERSION)) 41 42 # Url to bug filing site 43 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/ 44 45 # Common line for how to submit a bug or rfe 46 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> 47 48 # Url to devdocs page 49 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html 50 DEV_DOCS_URL-5 = http://java.sun.com/j2se/1.5.0/docs/index.html 51 DEV_DOCS_URL-6 = http://download.oracle.com/javase/6/docs/index.html 52 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html 53 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION)) 54 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs 55 56 # Url to Java Language Spec 57 #JLS3_URL = http://java.sun.com/docs/books/jls/ 58 59 # Common Java trademark line 60 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \ 61 $(FULL_COMPANY_NAME) in the US and other countries. 62 63 # 64 # Definitions for imported components 65 # 66 include $(BUILDDIR)/common/internal/ImportComponents.gmk 67 68 # We override whatever the max VM memory setting is here. 69 # NOTE: javadoc will not complete without these larger settings. 70 # WARNING: This could cause thrashing on low memory machines. 71 ifeq ($(ARCH_DATA_MODEL),64) 72 MAX_VM_MEMORY = 1024 73 else 74 MAX_VM_MEMORY = 612 75 endif 76 77 # List of all possible directories for javadoc to look for sources 78 # NOTE: Quotes are required around sourcepath argument only on Windows. 79 # Otherwise, you get "No packages or classes specified." due 80 # to $(CLASSPATH_SEPARATOR) being interpreted as an end of 81 # command (newline or shell ; character) 82 ALL_SOURCE_DIRS = $(SHARE_SRC)/classes \ 83 $(IMPORTSRCDIR) \ 84 $(GENSRCDIR) \ 85 $(SHARE_SRC)/../solaris/classes \ 86 $(SHARE_SRC)/../windows/classes \ 87 $(SHARE_SRC)/doc/stub 88 89 # List of directories that actually exist 90 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS)) 91 92 # List with classpath separator between them 93 EMPTY:= 94 SPACE:= $(EMPTY) $(EMPTY) 95 RELEASEDOCS_SOURCEPATH = \ 96 $(subst $(SPACE),$(CLASSPATH_SEPARATOR),$(strip $(ALL_SOURCE_DIRS))) 97 98 # Prep for javadoc creation, assumes $@ is an index.html file 99 define prep-javadoc 100 @if [ -f "$@" -a "$?" != "" ] ; then \ 101 $(ECHO) "# Dependencies have changed: $?"; \ 102 fi 103 $(RM) -r $(@D) 104 $(MKDIR) -p $(@D) 105 endef 106 107 # A cache of the directories in ALL_SOURCE_DIRS 108 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache 109 110 # Given a list of packages, return a list of files or dirs to be dependent on 111 # (Currently only returning a list of directories) 112 define PackageDependencies # packages 113 $(shell \ 114 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \ 115 for p in $1 ; do \ 116 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ 117 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \ 118 done; \ 119 fi \ 120 ) 121 endef 122 123 # Given a list of packages, add packages that exist to $@, print summary 124 define PackageFilter # packages 125 @if [ "$1" != "" ] ; then \ 126 for p in $1 ; do \ 127 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ 128 found="false"; \ 129 for cp in $(ALL_SOURCE_DIRS) ; do \ 130 if [ -d $${cp}/$${pd} ] ; then \ 131 $(ECHO) "$${p}" >> $@; \ 132 found="true"; \ 133 break; \ 134 fi; \ 135 done; \ 136 if [ "$${found}" = "false" ] ; then \ 137 $(ECHO) "WARNING: Package not found: $${p}"; \ 138 fi; \ 139 done; \ 140 fi 141 endef 142 143 # Print out a summary of the javadoc command about to be run 144 define JavadocSummary # optionsfile packagesfile 145 @$(ECHO) "# Summary for $@";\ 146 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \ 147 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2 148 endef 149 150 # 151 # Temporary directory for javadoc creation 152 # 153 DOCSTMPDIR = $(TEMPDIR)/doctmp 154 155 # 156 # Different api directories created from root directory 157 # 158 COREAPI_DOCSDIR = $(DOCSDIR)/api 159 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api 160 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api 161 PLATFORM_DOCSDIR = $(DOCSDIR)/platform 162 163 # The non-core api javadocs need to be able to access the root of the core 164 # api directory, so for jdk/api or jre/api to get to the core api/ 165 # directory we would use this: 166 JDKJRE2COREAPI = ../../api 167 168 # Common bottom argument 169 define CommonBottom # year 170 <font size="-1"><br> $(call CopyrightLine,,$1,)</font> 171 endef 172 173 # Common trademark bottom argument (Not sure why this is used sometimes) 174 define CommonTrademarkBottom # year 175 <font size="-1">\ 176 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\ 177 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\ 178 </font> 179 endef 180 181 # Common echo of option 182 define OptionOnly # opt 183 $(PRINTF) "%s\n" "$1" 184 endef 185 define OptionPair # opt arg 186 $(PRINTF) "%s '%s'\n" "$1" '$2' 187 endef 188 define OptionTrip # opt arg arg 189 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3' 190 endef 191 192 # Core api bottom argument (with special sauce) 193 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\ 194 <br>For further API reference and developer documentation, \ 195 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \ 196 That documentation contains more detailed, developer-targeted descriptions, \ 197 with conceptual overviews, definitions of terms, workarounds, \ 198 and working code examples.<br>\ 199 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\ 200 </font> 201 202 # Common javadoc options used by all 203 COMMON_JAVADOCFLAGS = \ 204 $(NO_PROPRIETARY_API_WARNINGS) \ 205 -quiet \ 206 -use \ 207 -keywords \ 208 $(ADDITIONAL_JAVADOCFLAGS) 209 210 ifdef OPENJDK 211 ADDITIONAL_JAVADOCFLAGS = \ 212 -Xdocrootparent $(DOCS_BASE_URL) 213 else 214 ADDITIONAL_JAVADOCFLAGS = 215 endif 216 217 # Draft used for non-fcs documents 218 JDK_IS_FCS = false 219 DRAFT_HEADER = 220 ifeq ($(JDK_MINOR_VERSION),5) 221 JDK_IS_FCS = true 222 endif 223 ifeq ($(JDK_MINOR_VERSION),6) 224 JDK_IS_FCS = true 225 endif 226 ifeq ($(JDK_MINOR_VERSION),7) 227 JDK_IS_FCS = true 228 endif 229 ifeq ($(JDK_IS_FCS),false) 230 ifneq ($(MILESTONE), fcs) 231 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> 232 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> 233 DRAFT_WINTITLE = $(BUILD_NUMBER) 234 # Early access top text (not used in FCS releases) 235 COREAPI_TOP_EARLYACCESS = \ 236 <div style="background-color: \#EEEEEE"> \ 237 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ 238 margin-left: 6px; margin-right: 6px; text-align: justify; \ 239 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ 240 font-weight: normal;"> \ 241 Please note that the specifications and other information \ 242 contained herein are not final and are subject to change. \ 243 The information is being made available to you solely for purpose of \ 244 evaluation. \ 245 </div> </div> 246 endif 247 endif 248 249 ################################################################# 250 251 # 252 # CORE_PKGS environment variable has been moved to the following file 253 # 254 include CORE_PKGS.gmk 255 256 # 257 # Load environment variables for API package names that are not part of 258 # the Java SE platform 259 # 260 include NON_CORE_PKGS.gmk 261 262 ################################################################# 263 264 # 265 # Default target is same as docs target, create core api and all others it can 266 # 267 268 all: docs 269 docs: coredocs otherdocs 270 271 ################################################################# 272 # Production Targets -- USE THESE TARGETS WHEN: 273 # a) You're generating docs outside of release engineering's 274 # standard control build. 275 # b) The docs will be pushed to the web and/or included in 276 # the downloaded doc bundle. 277 # 278 # See: Notes.html#releaseTargets 279 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!) 280 # 281 282 sanitycheckcoredocs: 283 @$(ECHO) "" 284 @$(ECHO) "Building core api docs with these values:" 285 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)" 286 @$(ECHO) " MILESTONE = $(MILESTONE)" 287 @$(ECHO) "" 288 ifeq ($(BUILD_NUMBER), b00) 289 @$(ECHO) "ERROR: Build number must be defined" 290 @$(ECHO) "MILESTONE is set to $(MILESTONE)" 291 @$(ECHO) "" 292 exit 1 293 endif 294 295 ############################################################# 296 # 297 # coredocs 298 # 299 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \ 300 $(JDK_MINOR_VERSION)<br>API Specification 301 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION) 302 COREAPI_HEADER = \ 303 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong> 304 305 # Java language specification cite 306 TAG_JLS = jls:a:See <cite> \ 307 The Java™ Language Specification</cite>: 308 309 # Overview file for core apis 310 COREAPI_OVERVIEW = $(SHARE_SRC)/classes/overview-core.html 311 312 # The index.html, options, and packages files 313 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html 314 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options 315 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages 316 317 coredocs: $(COREAPI_INDEX_FILE) 318 319 # Set relative location to core api document root 320 $(COREAPI_INDEX_FILE): GET2DOCSDIR=.. 321 322 # Run javadoc if the index file is out of date or missing 323 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE) 324 $(prep-javadoc) 325 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE)) 326 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 327 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE) 328 329 # Create file with javadoc options in it 330 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW) 331 $(prep-target) 332 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 333 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 334 $(call OptionPair,-encoding,ISO-8859-1) ; \ 335 $(call OptionPair,-tag,beaninfo:X) ; \ 336 $(call OptionPair,-tag,revised:X) ; \ 337 $(call OptionPair,-tag,since.unbundled:X) ; \ 338 $(call OptionPair,-tag,spec:X) ; \ 339 $(call OptionPair,-tag,specdefault:X) ; \ 340 $(call OptionPair,-tag,Note:X) ; \ 341 $(call OptionPair,-tag,ToDo:X) ; \ 342 $(call OptionPair,-tag,$(TAG_JLS)) ; \ 343 $(call OptionOnly,-splitIndex) ; \ 344 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \ 345 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \ 346 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\ 347 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \ 348 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 349 ) >> $@ 350 ifdef COREAPI_TOP_EARLYACCESS 351 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@ 352 endif 353 354 # Create a file with the package names in it 355 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS)) 356 $(prep-target) 357 $(call PackageFilter,$(CORE_PKGS)) 358 359 ############################################################# 360 # 361 # mirrordocs 362 # 363 364 # Part of langtools 365 ifdef LANGTOOLS_DIST 366 ALL_OTHER_TARGETS += mirrordocs 367 endif 368 369 MIRROR_DOCDIR := $(JDK_API_DOCSDIR)/apt/mirror 370 MIRROR2COREAPI := ../../$(JDKJRE2COREAPI) 371 MIRROR_DOCTITLE := Mirror API 372 MIRROR_WINDOWTITLE := Mirror API 373 MIRROR_HEADER := <strong>Mirror API</strong> 374 MIRROR_BOTTOM := $(call CommonBottom,$(MIRROR_FIRST_COPYRIGHT_YEAR)) 375 MIRROR_GROUPNAME := Packages 376 MIRROR_OVERVIEW := $(IMPORTSRCDIR)/com/sun/mirror/overview.html 377 MIRROR_REGEXP := com.sun.mirror.* 378 # MIRROR_PKGS is located in NON_CORE_PKGS.gmk 379 380 # The index.html, options, and packages files 381 MIRROR_INDEX_FILE = $(MIRROR_DOCDIR)/index.html 382 MIRROR_OPTIONS_FILE = $(DOCSTMPDIR)/mirror.options 383 MIRROR_PACKAGES_FILE = $(DOCSTMPDIR)/mirror.packages 384 385 mirrordocs: $(MIRROR_INDEX_FILE) 386 387 # Set relative location to core api document root 388 $(MIRROR_INDEX_FILE): GET2DOCSDIR=$(MIRROR2COREAPI)/.. 389 390 # Run javadoc if the index file is out of date or missing 391 $(MIRROR_INDEX_FILE): $(MIRROR_OPTIONS_FILE) $(MIRROR_PACKAGES_FILE) 392 $(prep-javadoc) 393 $(call JavadocSummary,$(MIRROR_OPTIONS_FILE),$(MIRROR_PACKAGES_FILE)) 394 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 395 @$(MIRROR_OPTIONS_FILE) @$(MIRROR_PACKAGES_FILE) 396 397 # Create file with javadoc options in it 398 $(MIRROR_OPTIONS_FILE): $(MIRROR_OVERVIEW) 399 $(prep-target) 400 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 401 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 402 $(call OptionPair,-encoding,ascii) ; \ 403 $(call OptionPair,-overview,$(MIRROR_OVERVIEW)) ; \ 404 $(call OptionPair,-doctitle,$(MIRROR_DOCTITLE)) ; \ 405 $(call OptionPair,-windowtitle,$(MIRROR_WINDOWTITLE) $(DRAFT_WINTITLE));\ 406 $(call OptionPair,-header,$(MIRROR_HEADER)$(DRAFT_HEADER)) ; \ 407 $(call OptionPair,-bottom,$(MIRROR_BOTTOM)$(DRAFT_BOTTOM)) ; \ 408 $(call OptionTrip,-group,$(MIRROR_GROUPNAME),$(MIRROR_REGEXP)); \ 409 $(call OptionTrip,-linkoffline,$(MIRROR2COREAPI),$(COREAPI_DOCSDIR)); \ 410 ) >> $@ 411 412 # Create a file with the package names in it 413 $(MIRROR_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MIRROR_PKGS)) 414 $(prep-target) 415 $(call PackageFilter,$(MIRROR_PKGS)) 416 417 ############################################################# 418 # 419 # docletapidocs 420 # 421 422 # Part of langtools 423 ifdef LANGTOOLS_DIST 424 ALL_OTHER_TARGETS += docletapidocs 425 endif 426 427 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet 428 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) 429 DOCLETAPI_DOCTITLE := Doclet API 430 DOCLETAPI_WINDOWTITLE := Doclet API 431 DOCLETAPI_HEADER := <strong>Doclet API</strong> 432 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) 433 DOCLETAPI_GROUPNAME := Packages 434 DOCLETAPI_REGEXP := com.sun.javadoc 435 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk 436 437 # The index.html, options, and packages files 438 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html 439 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options 440 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages 441 442 docletapidocs: $(DOCLETAPI_INDEX_FILE) 443 444 # Set relative location to core api document root 445 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/.. 446 447 # Run javadoc if the index file is out of date or missing 448 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) 449 $(prep-javadoc) 450 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE)) 451 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 452 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE) 453 454 # Create file with javadoc options in it 455 $(DOCLETAPI_OPTIONS_FILE): 456 $(prep-target) 457 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 458 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 459 $(call OptionPair,-encoding,ascii) ; \ 460 $(call OptionOnly,-breakiterator) ; \ 461 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \ 462 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\ 463 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ 464 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 465 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \ 466 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 467 ) >> $@ 468 469 # Create a file with the package names in it 470 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS)) 471 $(prep-target) 472 $(call PackageFilter,$(DOCLETAPI_PKGS)) 473 474 ############################################################# 475 # 476 # tagletapidocs 477 # 478 479 # Part of langtools 480 ifdef LANGTOOLS_DIST 481 ALL_OTHER_TARGETS += tagletapidocs 482 endif 483 484 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet 485 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) 486 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) 487 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk 488 489 # Temporary directory (special generation rules) 490 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp 491 492 # The index.html, options, and packages files 493 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html 494 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options 495 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages 496 497 tagletapidocs: $(TAGLETAPI_INDEX_FILE) 498 499 # Set relative location to core api document root 500 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/.. 501 502 # Run javadoc if the index file is out of date or missing 503 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) 504 $(prep-javadoc) 505 $(RM) -r $(TAGLETAPI_TEMPDIR) 506 $(MKDIR) -p $(TAGLETAPI_TEMPDIR) 507 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) 508 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(TAGLETAPI_TEMPDIR) \ 509 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) 510 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D) 511 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D) 512 $(RM) -r $(TAGLETAPI_TEMPDIR) 513 514 # Create file with javadoc options in it 515 $(TAGLETAPI_OPTIONS_FILE): 516 $(prep-target) 517 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 518 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 519 $(call OptionPair,-encoding,ascii) ; \ 520 $(call OptionOnly,-nonavbar) ; \ 521 $(call OptionOnly,-noindex) ; \ 522 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 523 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 524 ) >> $@ 525 526 # Create a file with the package names in it 527 $(TAGLETAPI_PACKAGES_FILE): $(IMPORTSRCDIR)/$(TAGLETAPI_FILE) 528 $(prep-target) 529 @($(ECHO) "$(IMPORTSRCDIR)/$(TAGLETAPI_FILE)" ) > $@ 530 531 ############################################################# 532 # 533 # domapidocs 534 # 535 536 ALL_OTHER_TARGETS += domapidocs 537 538 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom 539 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) 540 DOMAPI_DOCTITLE := Common DOM API 541 DOMAPI_WINDOWTITLE := Common DOM API 542 DOMAPI_HEADER := <strong>Common DOM API</strong> 543 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) 544 DOMAPI_GROUPNAME := Packages 545 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom* 546 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk 547 548 # The index.html, options, and packages files 549 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html 550 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options 551 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages 552 553 domapidocs: $(DOMAPI_INDEX_FILE) 554 555 # Set relative location to core api document root 556 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. 557 558 # Run javadoc if the index file is out of date or missing 559 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) 560 $(prep-javadoc) 561 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) 562 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 563 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) 564 565 # Create file with javadoc options in it 566 $(DOMAPI_OPTIONS_FILE): 567 $(prep-target) 568 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 569 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 570 $(call OptionPair,-encoding,ascii) ; \ 571 $(call OptionOnly,-splitIndex) ; \ 572 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ 573 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\ 574 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ 575 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 576 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ 577 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 578 ) >> $@ 579 580 # Create a file with the package names in it 581 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS)) 582 $(prep-target) 583 $(call PackageFilter,$(DOMAPI_PKGS)) 584 585 ############################################################# 586 # 587 # jpdadocs 588 # 589 590 ALL_OTHER_TARGETS += jpdadocs 591 592 jpdadocs: jdidocs jdwpdocs jvmtidocs 593 594 ############################################################# 595 # 596 # jdidocs 597 # 598 599 ALL_OTHER_TARGETS += jdidocs 600 601 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi 602 JDI2COREAPI := ../../$(JDKJRE2COREAPI) 603 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface 604 JDI_WINDOWTITLE := Java Debug Interface 605 JDI_HEADER := <strong>Java Debug Interface</strong> 606 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) 607 JDI_OVERVIEW := $(SHARE_SRC)/classes/jdi-overview.html 608 # JDI_PKGS is located in NON_CORE_PKGS.gmk 609 610 # The index.html, options, and packages files 611 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html 612 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options 613 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages 614 615 jdidocs: $(JDI_INDEX_FILE) 616 617 # Set relative location to core api document root 618 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. 619 620 # Run javadoc if the index file is out of date or missing 621 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) 622 $(prep-javadoc) 623 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) 624 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 625 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) 626 627 # Create file with javadoc options in it 628 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) 629 $(prep-target) 630 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 631 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 632 $(call OptionPair,-encoding,ascii) ; \ 633 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ 634 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ 635 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 636 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ 637 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 638 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ 639 ) >> $@ 640 641 # Create a file with the package names in it 642 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS)) 643 $(prep-target) 644 $(call PackageFilter,$(JDI_PKGS)) 645 646 ############################################################# 647 # 648 # jdwpdocs 649 # 650 651 ALL_OTHER_TARGETS += jdwpdocs 652 653 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp 654 JDWP_SPEC = $(BUILDDIR)/jpda/jdwp/jdwp.spec 655 JDWPGEN_JARFILE = $(BUILDTOOLJARDIR)/jdwpgen.jar 656 657 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html 658 $(JDWP_DOCDIR)/jdwp-protocol.html: $(JDWPGEN_JARFILE) $(JDWP_SPEC) 659 $(prep-javadoc) 660 $(BOOT_JAVA_CMD) -jar $(JDWPGEN_JARFILE) $(JDWP_SPEC) -doc $@ 661 662 ############################################################# 663 # 664 # jvmtidocs 665 # 666 667 ALL_OTHER_TARGETS += jvmtidocs 668 669 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti 670 JVMTI_HTML = $(HOTSPOT_DOCS_IMPORT_PATH)/platform/jvmti/jvmti.html 671 672 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html 673 $(JVMTI_DOCDIR)/jvmti.html: 674 @$(prep-javadoc) 675 @if [ -f $(JVMTI_HTML) ] ; then \ 676 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \ 677 $(CP) $(JVMTI_HTML) $@; \ 678 else \ 679 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \ 680 fi 681 682 ############################################################# 683 # 684 # jaasdocs 685 # 686 687 ALL_OTHER_TARGETS += jaasdocs 688 689 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec 690 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) 691 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service 692 JAAS_WINDOWTITLE := Java Authentication and Authorization Service 693 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> 694 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) 695 # JAAS_PKGS is located in NON_CORE_PKGS.gmk 696 JAAS_OVERVIEW := $(SHARE_SRC)/classes/com/sun/security/auth/jaas-overview.html 697 698 # The index.html, options, and packages files 699 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html 700 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options 701 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages 702 703 jaasdocs: $(JAAS_INDEX_FILE) 704 705 # Set relative location to core api document root 706 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. 707 708 # Run javadoc if the index file is out of date or missing 709 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) 710 $(prep-javadoc) 711 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) 712 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 713 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) 714 715 # Create file with javadoc options in it 716 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) 717 $(prep-target) 718 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 719 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 720 $(call OptionPair,-encoding,ascii) ; \ 721 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ 722 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ 723 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 724 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ 725 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 726 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ 727 ) >> $@ 728 729 # Create a file with the package names in it 730 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS)) 731 $(prep-target) 732 $(call PackageFilter,$(JAAS_PKGS)) 733 734 ############################################################# 735 # 736 # jgssdocs 737 # 738 739 ALL_OTHER_TARGETS += jgssdocs 740 741 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec 742 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) 743 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities 744 JGSS_WINDOWTITLE := Java GSS-API Utilities 745 JGSS_HEADER := <strong>Java GSS-API Utilities</strong> 746 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) 747 JGSS_OVERVIEW := $(SHARE_SRC)/classes/com/sun/security/jgss/jgss-overview.html 748 # JGSS_PKGS is located in NON_CORE_PKGS.gmk 749 750 # The index.html, options, and packages files 751 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html 752 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options 753 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages 754 755 jgssdocs: $(JGSS_INDEX_FILE) 756 757 # Set relative location to core api document root 758 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. 759 760 # Run javadoc if the index file is out of date or missing 761 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) 762 $(prep-javadoc) 763 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) 764 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 765 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) 766 767 # Create file with javadoc options in it 768 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) 769 $(prep-target) 770 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 771 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 772 $(call OptionPair,-encoding,ascii) ; \ 773 $(call OptionOnly,-nodeprecatedlist) ; \ 774 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ 775 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ 776 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 777 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ 778 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 779 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ 780 ) >> $@ 781 782 # Create a file with the package names in it 783 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS)) 784 $(prep-target) 785 $(call PackageFilter,$(JGSS_PKGS)) 786 787 ############################################################# 788 # 789 # smartcardiodocs 790 # 791 792 ALL_OTHER_TARGETS += smartcardiodocs 793 794 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec 795 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) 796 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O 797 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O 798 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> 799 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) 800 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk 801 802 # The index.html, options, and packages files 803 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html 804 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options 805 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages 806 807 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) 808 809 # Set relative location to core api document root 810 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. 811 812 # Run javadoc if the index file is out of date or missing 813 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) 814 $(prep-javadoc) 815 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) 816 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 817 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) 818 819 # Create file with javadoc options in it 820 $(SMARTCARDIO_OPTIONS_FILE): 821 $(prep-target) 822 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 823 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 824 $(call OptionPair,-encoding,ascii) ; \ 825 $(call OptionOnly,-nodeprecatedlist) ; \ 826 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ 827 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE));\ 828 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ 829 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ 830 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ 831 ) >> $@ 832 833 # Create a file with the package names in it 834 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS)) 835 $(prep-target) 836 $(call PackageFilter,$(SMARTCARDIO_PKGS)) 837 838 ############################################################# 839 # 840 # httpserverdocs 841 # 842 843 ALL_OTHER_TARGETS += httpserverdocs 844 845 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec 846 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) 847 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server 848 HTTPSERVER_WINDOWTITLE := Java HTTP Server 849 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> 850 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) 851 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk 852 853 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html 854 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options 855 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages 856 857 httpserverdocs: $(HTTPSERVER_INDEX_HTML) 858 859 # Set relative location to core api document root 860 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. 861 862 # Run javadoc if the index file is out of date or missing 863 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) 864 $(prep-javadoc) 865 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) 866 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 867 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) 868 869 # Create file with javadoc options in it 870 $(HTTPSERVER_OPTIONS_FILE): 871 $(prep-target) 872 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 873 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 874 $(call OptionPair,-encoding,ascii) ; \ 875 $(call OptionOnly,-nodeprecatedlist) ; \ 876 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ 877 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE));\ 878 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ 879 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ 880 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ 881 ) >> $@ 882 883 # Create a file with the package names in it 884 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS)) 885 $(prep-target) 886 $(call PackageFilter,$(HTTPSERVER_PKGS)) 887 888 ############################################################# 889 # 890 # mgmtdocs 891 # 892 893 ALL_OTHER_TARGETS += mgmtdocs 894 895 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension 896 MGMT2COREAPI := ../../$(JDKJRE2COREAPI) 897 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib 898 JVM_MIB_SRC := $(CLOSED_SRC)/share/classes/sun/management/snmp/$(JVM_MIB_NAME) 899 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform 900 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform 901 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> 902 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) 903 MGMT_OVERVIEW := $(SHARE_SRC)/classes/com/sun/management/mgmt-overview.html 904 # MGMT_PKGS is located in NON_CORE_PKGS.gmk 905 906 # The index.html, options, and packages files 907 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html 908 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options 909 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages 910 911 mgmtdocs: $(MGMT_INDEX_FILE) 912 913 # Set relative location to core api document root 914 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. 915 916 # Run javadoc if the index file is out of date or missing 917 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) 918 $(prep-javadoc) 919 @if [ -f $(JVM_MIB_SRC) ] ; then \ 920 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \ 921 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \ 922 else \ 923 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \ 924 fi 925 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) 926 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 927 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) 928 929 # Create file with javadoc options in it 930 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) 931 $(prep-target) 932 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 933 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 934 $(call OptionPair,-encoding,ascii) ; \ 935 $(call OptionOnly,-nodeprecatedlist) ; \ 936 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ 937 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ 938 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 939 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ 940 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ 941 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ 942 ) >> $@ 943 944 # Create a file with the package names in it 945 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS)) 946 $(prep-target) 947 $(call PackageFilter,$(MGMT_PKGS)) 948 949 ############################################################# 950 # 951 # attachdocs 952 # 953 954 ALL_OTHER_TARGETS += attachdocs 955 956 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec 957 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) 958 ATTACH_DOCTITLE := Attach API 959 ATTACH_WINDOWTITLE := Attach API 960 ATTACH_HEADER := <strong>Attach API</strong> 961 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) 962 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk 963 964 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html 965 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options 966 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages 967 968 attachdocs: $(ATTACH_INDEX_HTML) 969 970 # Set relative location to core api document root 971 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. 972 973 # Run javadoc if the index file is out of date or missing 974 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) 975 $(prep-javadoc) 976 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) 977 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 978 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) 979 980 # Create file with javadoc options in it 981 $(ATTACH_OPTIONS_FILE): 982 $(prep-target) 983 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 984 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 985 $(call OptionPair,-encoding,ascii) ; \ 986 $(call OptionOnly,-nodeprecatedlist) ; \ 987 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ 988 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE));\ 989 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ 990 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ 991 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ 992 ) >> $@ 993 994 # Create a file with the package names in it 995 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS)) 996 $(prep-target) 997 $(call PackageFilter,$(ATTACH_PKGS)) 998 999 ############################################################# 1000 # 1001 # jconsoledocs 1002 # 1003 1004 ALL_OTHER_TARGETS += jconsoledocs 1005 1006 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec 1007 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) 1008 JCONSOLE_DOCTITLE := JConsole API 1009 JCONSOLE_WINDOWTITLE := JConsole API 1010 JCONSOLE_HEADER := <strong>JConsole API</strong> 1011 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) 1012 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk 1013 1014 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html 1015 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options 1016 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages 1017 1018 jconsoledocs: $(JCONSOLE_INDEX_HTML) 1019 1020 # Set relative location to core api document root 1021 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. 1022 1023 # Run javadoc if the index file is out of date or missing 1024 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) 1025 $(prep-javadoc) 1026 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) 1027 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 1028 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) 1029 1030 # Create file with javadoc options in it 1031 $(JCONSOLE_OPTIONS_FILE): 1032 $(prep-target) 1033 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 1034 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1035 $(call OptionPair,-encoding,ascii) ; \ 1036 $(call OptionOnly,-nodeprecatedlist) ; \ 1037 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ 1038 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE));\ 1039 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ 1040 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1041 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ 1042 ) >> $@ 1043 1044 # Create a file with the package names in it 1045 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS)) 1046 $(prep-target) 1047 $(call PackageFilter,$(JCONSOLE_PKGS)) 1048 1049 ############################################################# 1050 # 1051 # treeapidocs 1052 # 1053 1054 # Part of langtools 1055 ifdef LANGTOOLS_DIST 1056 ALL_OTHER_TARGETS += treeapidocs 1057 endif 1058 1059 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree 1060 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1061 TREEAPI_DOCTITLE := Compiler Tree API 1062 TREEAPI_WINDOWTITLE := Compiler Tree API 1063 TREEAPI_HEADER := <strong>Compiler Tree API</strong> 1064 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) 1065 TREEAPI_GROUPNAME := Packages 1066 TREEAPI_REGEXP := com.sun.source.* 1067 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk 1068 1069 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html 1070 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options 1071 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages 1072 1073 treeapidocs: $(TREEAPI_INDEX_HTML) 1074 1075 # Set relative location to core api document root 1076 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. 1077 1078 # Run javadoc if the index file is out of date or missing 1079 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) 1080 $(prep-javadoc) 1081 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) 1082 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 1083 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) 1084 1085 # Create file with javadoc options in it 1086 $(TREEAPI_OPTIONS_FILE): 1087 $(prep-target) 1088 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 1089 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1090 $(call OptionPair,-encoding,ascii) ; \ 1091 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \ 1092 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\ 1093 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \ 1094 $(call OptionPair,-tag,$(TAG_JLS)) ; \ 1095 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1096 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ 1097 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1098 ) >> $@ 1099 1100 # Create a file with the package names in it 1101 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS)) 1102 $(prep-target) 1103 $(call PackageFilter,$(TREEAPI_PKGS)) 1104 1105 ############################################################# 1106 # 1107 # sctpdocs 1108 # 1109 1110 ALL_OTHER_TARGETS += sctpdocs 1111 1112 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec 1113 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1114 SCTPAPI_DOCTITLE := SCTP API 1115 SCTPAPI_WINDOWTITLE := SCTP API 1116 SCTPAPI_HEADER := <strong>SCTP API</strong> 1117 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) 1118 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk 1119 1120 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html 1121 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options 1122 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages 1123 1124 sctpdocs: $(SCTPAPI_INDEX_HTML) 1125 1126 # Set relative location to core api document root 1127 $(SCTSCTSCTP: GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. 1128 1129 # Run javadoc if the index file is out of date or missing 1130 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) 1131 $(prep-javadoc) 1132 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) 1133 $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \ 1134 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) 1135 1136 # Create file with javadoc options in it 1137 $(SCTPAPI_OPTIONS_FILE): 1138 $(prep-target) 1139 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \ 1140 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ 1141 $(call OptionPair,-encoding,ascii) ; \ 1142 $(call OptionOnly,-nodeprecatedlist) ; \ 1143 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ 1144 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\ 1145 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ 1146 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1147 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1148 ) >> $@ 1149 1150 # Create a file with the package names in it 1151 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS)) 1152 $(prep-target) 1153 $(call PackageFilter,$(SCTPAPI_PKGS)) 1154 1155 ############################################################# 1156 # 1157 # Get a cache of all the directories 1158 1159 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS) 1160 $(prep-target) 1161 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \ 1162 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \ 1163 $(FIND) $${cp} -type f >> $@; \ 1164 done 1165 1166 ############################################################# 1167 #release version of core packages ######## 1168 # Maximize performance and ensure that build number & milestone are set. 1169 1170 rel-coredocs: sanitycheckcoredocs 1171 $(MAKE) coredocs 1172 1173 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS) 1174 # 1175 # end of production targets 1176 1177 otherdocs: $(ALL_OTHER_TARGETS) 1178 1179 clean: 1180 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR) 1181 1182 ############################################################# 1183 # DEBUG TARGET 1184 # List the values defined in the makefile hierarchy, to make sure everything 1185 # is set properly, and to help identify values we can use instead of making new ones. 1186 # (Most of them come from common/shared/Defs.gmk) 1187 # 1188 # Notes: 1189 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value> 1190 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line 1191 # 1192 1193 echovalues: 1194 @$(ECHO) "" 1195 @$(ECHO) --------------Imports--------------------------- 1196 @$(ECHO) "IMPORT_PACKAGES = $(IMPORT_PACKAGES)" 1197 @$(ECHO) "IMPORT_PACKAGE_FILTER = $(IMPORT_PACKAGE_FILTER)" 1198 @$(ECHO) --------------Imports--------------------------- 1199 @$(ECHO) "" 1200 @$(ECHO) --------------Shared--------------------------- 1201 @$(ECHO) BUILD_NUMBER = $(BUILD_NUMBER) 1202 @$(ECHO) FULL_VERSION = $(FULL_VERSION) 1203 @$(ECHO) JDK_VERSION = $(JDK_VERSION) 1204 @$(ECHO) JDK_MAJOR_VERSION = $(JDK_MAJOR_VERSION) 1205 @$(ECHO) JDK_MINOR_VERSION = $(JDK_MINOR_VERSION) 1206 @$(ECHO) JDK_MICRO_VERSION = $(JDK_MICRO_VERSION) 1207 @$(ECHO) JDK_UPDATE_VERSION = $(JDK_UPDATE_VERSION) 1208 @$(ECHO) JDK_MKTG_VERSION = $(JDK_MKTG_VERSION) 1209 @$(ECHO) JDK_UNDERSCORE_VERSION = $(JDK_UNDERSCORE_VERSION) 1210 @$(ECHO) JDK_MKTG_UNDERSCORE_VERSION = $(JDK_MKTG_UNDERSCORE_VERSION) 1211 @$(ECHO) MARKETING_NUMBER = $(MARKETING_NUMBER) 1212 @$(ECHO) MARKET_NAME = $(MARKET_NAME) 1213 @$(ECHO) MILESTONE = $(MILESTONE) 1214 @$(ECHO) RELEASE = $(RELEASE) 1215 @$(ECHO) USER_RELEASE_SUFFIX = $(USER_RELEASE_SUFFIX) 1216 @$(ECHO) --------------Shared--------------------------- 1217 @$(ECHO) "" 1218 @$(ECHO) --------------common/Defs--------------------------- 1219 @$(ECHO) "RELEASEDOCS_SOURCEPATH" 1220 @$(ECHO) " SHARE_SRC/classes: $(SHARE_SRC)/classes" 1221 @$(ECHO) " PLATFORM_SRC/classes: $(PLATFORM_SRC)/classes" 1222 @$(ECHO) " GENSRCDIR: $(GENSRCDIR)" 1223 @$(ECHO) " SHARE_SRC/doc/stub: $(SHARE_SRC)/doc/stub" 1224 @$(ECHO) " IMPORTSRCDIR: $(IMPORTSRCDIR)" 1225 @$(ECHO) --------------common/Defs--------------------------- 1226 @$(ECHO) "" 1227 1228 ############################################################# 1229 .PHONY: all docs coredocs rel-docs echovalues otherdocs rel-coredocs \ 1230 sanitycheckcoredocs $(ALL_OTHER_TARGETS) 1231