make/Javadoc.gmk

Mon, 14 Apr 2014 14:25:09 +0000

author
michaelm
date
Mon, 14 Apr 2014 14:25:09 +0000
changeset 1033
4900092f003c
parent 912
a667caba1e84
child 1039
389603b4000d
permissions
-rw-r--r--

8032808: Support Solaris SO_FLOW_SLA socket option
Reviewed-by: alanb, chegar

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

mercurial