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