make/Javadoc.gmk

Mon, 14 Sep 2020 16:42:03 +0100

author
andrew
date
Mon, 14 Sep 2020 16:42:03 +0100
changeset 2554
7f60c2d9823e
parent 2542
741aff26fe61
child 2556
76a0f827e163
permissions
-rw-r--r--

Added tag jdk8u272-b08 for changeset 34c6baf21464

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

mercurial