make/Javadoc.gmk

Mon, 16 Oct 2017 15:57:35 +0800

author
aoqi
date
Mon, 16 Oct 2017 15:57:35 +0800
changeset 1482
8fb429038513
parent 1400
0d3041c21ce9
parent 1288
7801df19942d
child 1859
8b0588603185
permissions
-rw-r--r--

merge

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

mercurial