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