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