Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / libcore / 319a3b994703aac84df7bcde272adfcb3cdbbbf0 / . / jdk / make / docs / Makefile
blob: 328244b9a97b1bebedea1b33c7e307c62cb24ae7 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +0000[diff] [blame^]1#
2# Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# This code is free software; you can redistribute it and/or modify it
6# under the terms of the GNU General Public License version 2 only, as
7# published by the Free Software Foundation. Sun designates this
8# particular file as subject to the "Classpath" exception as provided
9# by Sun in the LICENSE file that accompanied this code.
10#
11# This code is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14# version 2 for more details (a copy is included in the LICENSE file that
15# accompanied this code).
16#
17# You should have received a copy of the GNU General Public License version
18# 2 along with this work; if not, write to the Free Software Foundation,
19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20#
21# Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22# CA 95054 USA or visit www.sun.com if you need additional information or
23# have any questions.
24#
25
26#
27# Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
28#
29BUILDDIR=..
30PRODUCT=docs
31include $(BUILDDIR)/common/Defs.gmk
32
33# We override whatever the max VM memory setting is here.
34# NOTE: javadoc will not complete without these larger settings.
35# WARNING: This could cause thrashing on low memory machines.
36ifeq ($(ARCH_DATA_MODEL),64)
37 MAX_VM_MEMORY = 1024
38else
39 MAX_VM_MEMORY = 512
40endif
41
42#
43# Variables used by docs target
44#
45DOCSTMPDIR = $(TEMPDIR)/doctmp
46
47COMMON_JAVADOCFLAGS = \
48 -source 1.5 \
49 -quiet \
50 -use \
51 -keywords \
52 $(JAVADOC_VM_MEMORY_FLAGS) \
53 $(ADDITIONAL_JAVADOCFLAGS)
54ADDITIONAL_JAVADOCFLAGS =
55
56CORE_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
57 $(TAGS) \
58 -encoding ISO-8859-1 \
59 -splitIndex \
60 -doctitle $(DOCTITLE_SWITCH) \
61 -windowtitle $(WINDOWTITLE_SWITCH) \
62 -header $(HEADER_SWITCH) \
63 $(TOPOPTION) \
64 -bottom $(JAVADOCBOTTOM_SWITCH) \
65 $(OVERVIEW_OPTION)
66
67DRAFT = '<br><b>DRAFT&nbsp;'$(MILESTONE)-$(BUILD_NUMBER)'</b>'
68THIS_YEAR := $(shell $(DATE) | $(SED) -e 's/ / /g' | $(CUT) -d' ' -f6)
69TRADEMARK = &\#x2122;
70
71IGNORED_TAGS = beaninfo revised since.unbundled spec Note ToDo
72
73JLS3_URL = http://java.sun.com/docs/books/jls/
74JLS3_CITE = <a href="$(JLS3_URL)"> \
75 The Java Language Specification, Third Edition</a>
76TAG_JLS3 = -tag 'jls3:a:See <cite>$(JLS3_CITE)</cite>:'
77
78TAGS = $(IGNORED_TAGS:%=-tag %:X) $(TAG_JLS3)
79
80ifeq ($(MILESTONE), fcs)
81 DOCTITLE_SWITCH = $(JAVADOCTITLE)
82 WINDOWTITLE_SWITCH = $(JAVADOCWINDOWTITLE)
83 HEADER_SWITCH = $(JAVADOCHEADER)
84 TOPOPTION=
85 JAVADOCBOTTOM_SWITCH= $(JAVADOCBOTTOM)
86 OVERVIEW_OPTION = -overview $(JAVADOCOVERVIEW)
87else
88 DOCTITLE_SWITCH = $(JAVADOCTITLE_EARLYACCESS)$(DRAFT)
89 WINDOWTITLE_SWITCH = $(JAVADOCWINDOWTITLE)" $(BUILD_NUMBER)"
90 HEADER_SWITCH = $(JAVADOCHEADER)$(DRAFT)
91 JAVADOCBOTTOM_SWITCH= $(JAVADOCBOTTOM_EARLYACCESS)
92 TOPOPTION= -top $(JAVADOCTOP_EARLYACCESS)
93 OVERVIEW_OPTION =
94endif
95
96JAVADOCTITLE = 'Java$(TRADEMARK) Platform, Standard Edition $(JDK_MINOR_VERSION)<br>API Specification'
97JAVADOCWINDOWTITLE = 'Java Platform SE $(JDK_MINOR_VERSION)'
98JAVADOCHEADER = '<b>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</b>'
99JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="{@docroot}/../../webnotes/devdocs-vs-specs.html">Java SE Developer Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples. <p>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to <a href="{@docroot}/../legal/license.html">license terms</a>. Also see the <a href="http://java.sun.com/docs/redist.html">documentation redistribution policy</a>.</font>'
100JAVADOCOVERVIEW = $(SHARE_SRC)/classes/overview-core.html
101
102#
103# Early access top and bottom text (for snapshots, beta and rc)
104#
105JAVADOCTOP_EARLYACCESS = '<div style="background-color: \#EEEEEE"> <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; margin-left: 6px; margin-right: 6px; text-align: justify; font-size: 80%; font-family: Helvetica, Arial, sans-serif; font-weight: normal;"> Please note that this documentation is not final and is subject to change. </div> </div>'
106JAVADOCBOTTOM_EARLYACCESS = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a> <p>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to <a href="{@docroot}/../legal/license.html">license terms</a>.</font>'
107JAVADOCTITLE_EARLYACCESS = $(subst Specification,Documentation,$(JAVADOCTITLE))
108
109#
110# Variables used by domapidocs target
111#
112
113DOMAPI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
114 -encoding ascii \
115 -splitIndex \
116 -doctitle $(DOMAPI_JAVADOCTITLE) \
117 -windowtitle $(DOMAPI_JAVADOCWINDOWTITLE) \
118 -header $(DOMAPI_JAVADOCHEADER) \
119 -bottom $(DOMAPI_JAVADOCBOTTOM) \
120 -group $(DOMAPI_GROUPNAME) $(DOMAPI_REGEXP)
121DOMAPI_JAVADOCTITLE = 'Common DOM API'
122DOMAPI_JAVADOCWINDOWTITLE = 'Common DOM API'
123DOMAPI_JAVADOCHEADER = '<b>Common DOM API</b>'
124DOMAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A. All Rights Reserved.</font>'
125DOMAPI_GROUPNAME = "Packages"
126DOMAPI_REGEXP = "com.sun.java.browser.dom:org.w3c.dom*"
127# DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
128
129#
130# Variables used by mirrordocs target
131#
132
133MIRROR_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
134 -encoding ascii \
135 -doctitle $(MIRROR_JAVADOCTITLE) \
136 -windowtitle $(MIRROR_JAVADOCWINDOWTITLE) \
137 -header $(MIRROR_JAVADOCHEADER) \
138 -bottom $(MIRROR_JAVADOCBOTTOM) \
139 -group $(MIRROR_GROUPNAME) $(MIRROR_REGEXP) \
140 -overview $(MIRROR_OVERVIEW)
141MIRROR_JAVADOCTITLE = 'Mirror API'
142MIRROR_JAVADOCWINDOWTITLE = 'Mirror API'
143MIRROR_JAVADOCHEADER = '<b>Mirror API</b>'
144MIRROR_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Report a bug or request a feature.</a><br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.</font>'
145MIRROR_GROUPNAME = "Packages"
146MIRROR_OVERVIEW = $(IMPORTSRCDIR)/com/sun/mirror/overview.html
147MIRROR_REGEXP = "com.sun.mirror.*"
148MIRROR_DESTDIR = $(DOCSDIR)/jdk/api/apt/mirror
149MIRROR_LINKOPT = -linkoffline ../../../../api $(DOCSDIR)/api/
150# MIRROR_PKGS is located in NON_CORE_PKGS.gmk
151
152#
153# Variables used by docletapidocs target
154#
155
156DOCLETAPI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
157 -breakiterator \
158 -encoding ascii \
159 -doctitle $(DOCLETAPI_JAVADOCTITLE) \
160 -windowtitle $(DOCLETAPI_JAVADOCWINDOWTITLE) \
161 -header $(DOCLETAPI_JAVADOCHEADER) \
162 -bottom $(DOCLETAPI_JAVADOCBOTTOM) \
163 -group $(DOCLETAPI_GROUPNAME) $(DOCLETAPI_REGEXP)
164DOCLETAPI_JAVADOCTITLE = 'Doclet API'
165DOCLETAPI_JAVADOCWINDOWTITLE = 'Doclet API'
166DOCLETAPI_JAVADOCHEADER = '<b>Doclet API</b>'
167DOCLETAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-$(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A. All Rights Reserved.</font>'
168DOCLETAPI_GROUPNAME = "Packages"
169DOCLETAPI_REGEXP = "com.sun.javadoc"
170DOCLETAPI_LINKOPT = -linkoffline ../../../../api $(DOCSDIR)/api/
171# DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
172
173#
174# Variables used by tagletapidocs target
175#
176
177TAGLETAPI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
178 -encoding ascii \
179 -nonavbar \
180 -noindex \
181 -bottom $(TAGLETAPI_JAVADOCBOTTOM)
182TAGLETAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-$(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A. All Rights Reserved.</font>'
183# TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
184
185#
186# Variables used by jdi target
187#
188
189JPDA_SOURCEPATH = $(TOPDIR)/src/share/classes
190
191JDI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
192 -encoding ascii \
193 -nodeprecatedlist \
194 -d $(DOCSDIR)/jdk/api/jpda/jdi \
195 -sourcepath $(JPDA_SOURCEPATH) \
196 -windowtitle $(JDI_WINDOWTITLE) \
197 -doctitle $(JDI_DOCTITLE) \
198 -header $(JDI_HEADER) \
199 -linkoffline ../../../../api $(DOCSDIR)/api/ \
200 -overview $(JPDA_SOURCEPATH)/jdi-overview.html
201JDI_WINDOWTITLE = "Java Debug Interface"
202JDI_DOCTITLE = "Java$(TRADEMARK) Debug Interface"
203JDI_HEADER = "Java Debug Interface"
204# JDI_PKGS is located in NON_CORE_PKGS.gmk
205
206#
207# Variables used by JAAS target
208#
209# NOTE: Quotes are required around sourcepath argument only on Windows. Otherwise,
210# you get "No packages or classes specified." due to $(CLASSPATH_SEPARATOR)
211# being interpreted as an end of command (newline)
212
213JAAS_SOURCEPATH = "$(TOPDIR)/src/share/classes$(CLASSPATH_SEPARATOR)$(TOPDIR)/src/solaris/classes$(CLASSPATH_SEPARATOR)$(TOPDIR)/src/windows/classes$(CLASSPATH_SEPARATOR)$(TOPDIR)/src/linux/classes"
214JAAS_DOCDIR = $(DOCSDIR)/jre/api/security/jaas/spec
215JAAS_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
216 -encoding ascii \
217 -nodeprecatedlist \
218 -d $(JAAS_DOCDIR) \
219 -sourcepath $(JAAS_SOURCEPATH) \
220 -windowtitle $(JAAS_WINDOWTITLE) \
221 -doctitle $(JAAS_DOCTITLE) \
222 -header $(JAAS_JAVADOCHEADER) \
223 -linkoffline ../../../../../api $(DOCSDIR)/api/ \
224 -overview $(TOPDIR)/src/share/classes/com/sun/security/auth/jaas-overview.html
225JAAS_WINDOWTITLE = "Java Authentication and Authorization Service "
226JAAS_DOCTITLE = "Java$(TRADEMARK) Authentication and Authorization Service"
227JAAS_JAVADOCHEADER = "JAAS"
228# JAAS_PKGS is located in NON_CORE_PKGS.gmk
229
230#
231# Variables used by JGSS target
232#
233
234JGSS_SOURCEPATH = $(TOPDIR)/src/share/classes
235JGSS_DOCDIR = $(DOCSDIR)/jre/api/security/jgss/spec
236
237JGSS_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
238 -encoding ascii \
239 -nodeprecatedlist \
240 -d $(JGSS_DOCDIR) \
241 -sourcepath $(JGSS_SOURCEPATH) \
242 -windowtitle $(JGSS_WINDOWTITLE) \
243 -doctitle $(JGSS_DOCTITLE) \
244 -header $(JGSS_JAVADOCHEADER) \
245 -linkoffline ../../../../../api $(DOCSDIR)/api/ \
246 -overview $(JGSS_SOURCEPATH)/com/sun/security/jgss/jgss-overview.html
247
248JGSS_WINDOWTITLE = "Java GSS-API Utilities "
249JGSS_DOCTITLE = "Java$(TRADEMARK) GSS-API Utilities"
250JGSS_JAVADOCHEADER = "Java GSS-API Utilities"
251# JGSS_PKGS is located in NON_CORE_PKGS.gmk
252
253#
254# Variables used by SMARTCARDIO target
255#
256
257SMARTCARDIO_SOURCEPATH = $(TOPDIR)/src/share/classes
258SMARTCARDIO_DOCDIR = $(DOCSDIR)/jre/api/security/smartcardio/spec
259
260SMARTCARDIO_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
261 -encoding ascii \
262 -nodeprecatedlist \
263 -d $(SMARTCARDIO_DOCDIR) \
264 -sourcepath $(SMARTCARDIO_SOURCEPATH) \
265 -windowtitle $(SMARTCARDIO_WINDOWTITLE) \
266 -doctitle $(SMARTCARDIO_DOCTITLE) \
267 -header $(SMARTCARDIO_JAVADOCHEADER) \
268 -linkoffline ../../../../../api $(DOCSDIR)/api/
269
270SMARTCARDIO_WINDOWTITLE = "Java Smart Card I/O"
271SMARTCARDIO_DOCTITLE = "Java$(TRADEMARK) Smart Card I/O"
272SMARTCARDIO_JAVADOCHEADER = "Java Smart Card I/O"
273# SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
274
275#
276# Variables used by HTTPSERVER target
277#
278
279HTTPSERVER_SOURCEPATH = $(TOPDIR)/src/share/classes
280HTTPSERVER_DOCDIR = $(DOCSDIR)/jre/api/net/httpserver/spec
281
282HTTPSERVER_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
283 -encoding ascii \
284 -nodeprecatedlist \
285 -d $(HTTPSERVER_DOCDIR) \
286 -sourcepath $(HTTPSERVER_SOURCEPATH) \
287 -windowtitle $(HTTPSERVER_WINDOWTITLE) \
288 -doctitle $(HTTPSERVER_DOCTITLE) \
289 -header $(HTTPSERVER_JAVADOCHEADER) \
290 -linkoffline ../../../../../api $(DOCSDIR)/api/
291
292HTTPSERVER_WINDOWTITLE = "Java HTTP Server"
293HTTPSERVER_DOCTITLE = "Java$(TRADEMARK) HTTP Server"
294HTTPSERVER_JAVADOCHEADER = "Java HTTP Server"
295# HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
296
297#
298# Variables used by jvmti target
299#
300JVMTI_DOCS_SUBDIR = platform/jvmti
301JVMTI_HTML = $(HOTSPOT_DOCS_IMPORT_PATH)/$(JVMTI_DOCS_SUBDIR)/jvmti.html
302
303#
304# Variables used by mgmt target
305#
306MGMT_DOCDIR = $(DOCSDIR)/jre/api/management/
307MGMT_EXT_DIR = $(MGMT_DOCDIR)/extension
308MGMT_SOURCEPATH = $(TOPDIR)/src/share/classes
309JVM_MIB_NAME = JVM-MANAGEMENT-MIB.mib
310JVM_MIB_SRC = $(CLOSED_SRC)/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
311
312ifdef OPENJDK
313 COPY-MIB-TARGET =
314else
315 COPY-MIB-TARGET = copy-mib
316endif
317MGMT_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
318 -encoding ascii \
319 -nodeprecatedlist \
320 -d $(MGMT_EXT_DIR) \
321 -sourcepath $(MGMT_SOURCEPATH) \
322 -windowtitle $(MGMT_WINDOWTITLE) \
323 -doctitle $(MGMT_DOCTITLE) \
324 -header $(MGMT_HEADER) \
325 -linkoffline ../../../../api $(DOCSDIR)/api/ \
326 -overview $(MGMT_SOURCEPATH)/com/sun/management/mgmt-overview.html
327MGMT_WINDOWTITLE = "Monitoring and Management Interface for the Java Platform"
328MGMT_DOCTITLE = "Monitoring and Management Interface for the Java$(TRADEMARK) Platform"
329MGMT_HEADER = "Monitoring and Management Interface for the Java Platform"
330# MGMT_PKGS is located in NON_CORE_PKGS.gmk
331
332#
333# Variables used by attach target
334#
335
336ATTACH_SOURCEPATH = $(TOPDIR)/src/share/classes
337ATTACH_DOCDIR = $(DOCSDIR)/jdk/api/attach/spec
338ATTACH_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
339 -encoding ascii \
340 -nodeprecatedlist \
341 -d $(ATTACH_DOCDIR) \
342 -sourcepath $(ATTACH_SOURCEPATH) \
343 -windowtitle $(ATTACH_WINDOWTITLE) \
344 -doctitle $(ATTACH_DOCTITLE) \
345 -header $(ATTACH_HEADER) \
346 -linkoffline ../../../../api $(DOCSDIR)/api/
347ATTACH_WINDOWTITLE = "Attach API"
348ATTACH_DOCTITLE = "Attach API"
349ATTACH_HEADER = "Attach API"
350# ATTACH_PKGS is located in NON_CORE_PKGS.gmk
351
352#
353# Variables used by jconsole target
354#
355
356JCONSOLE_SOURCEPATH = $(TOPDIR)/src/share/classes
357JCONSOLE_DOCDIR = $(DOCSDIR)/jdk/api/jconsole/spec
358JCONSOLE_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
359 -encoding ascii \
360 -nodeprecatedlist \
361 -d $(JCONSOLE_DOCDIR) \
362 -sourcepath $(JCONSOLE_SOURCEPATH) \
363 -windowtitle $(JCONSOLE_WINDOWTITLE) \
364 -doctitle $(JCONSOLE_DOCTITLE) \
365 -header $(JCONSOLE_HEADER) \
366 -linkoffline ../../../../api $(DOCSDIR)/api/
367JCONSOLE_WINDOWTITLE = "JConsole API"
368JCONSOLE_DOCTITLE = "JConsole API"
369JCONSOLE_HEADER = "JConsole API"
370# JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
371
372#
373# Variables used by treeapidocs target
374#
375
376TREEAPI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS) \
377 -encoding ascii \
378 -doctitle $(TREEAPI_JAVADOCTITLE) \
379 -windowtitle $(TREEAPI_JAVADOCWINDOWTITLE) \
380 -header $(TREEAPI_JAVADOCHEADER) \
381 -bottom $(TREEAPI_JAVADOCBOTTOM) \
382 -group $(TREEAPI_GROUPNAME) $(TREEAPI_REGEXP)
383#
384# -overview $(TREEAPI_OVERVIEW)
385#
386TREEAPI_JAVADOCTITLE = 'Compiler Tree API'
387TREEAPI_JAVADOCWINDOWTITLE = 'Compiler Tree API'
388TREEAPI_JAVADOCHEADER = '<b>Compiler Tree API</b>'
389TREEAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Report a bug or request a feature.</a><br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.</font>'
390TREEAPI_GROUPNAME = "Packages"
391TREEAPI_OVERVIEW = $(SHARE_SRC)/classes/com/sun/source/overview.html
392TREEAPI_REGEXP = "com.sun.source.*"
393TREEAPI_DESTDIR = $(DOCSDIR)/jdk/api/javac/tree
394TREEAPI_LINKOPT = -linkoffline ../../../../api $(DOCSDIR)/api/
395# TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
396
397#
398# Path where javadoc should find source files for release docs
399#
400RELEASEDOCS_SRCPATH = "$(SHARE_SRC)/classes$(CLASSPATH_SEPARATOR)$(PLATFORM_SRC)/classes$(CLASSPATH_SEPARATOR)$(GENSRCDIR)$(CLASSPATH_SEPARATOR)$(SHARE_SRC)/doc/stub$(CLASSPATH_SEPARATOR)$(CLOSED_SRC)/share/classes$(CLASSPATH_SEPARATOR)$(IMPORTSRCDIR)"
401
402#
403# CORE_PKGS environment variable has been moved to the following file
404#
405include CORE_PKGS.gmk
406
407#
408# Load environment variables for API package names that are not part of
409# the Java SE platform
410#
411include NON_CORE_PKGS.gmk
412
413# Targets for all APIs other than the core platform APIs
414ALL_OTHER_TARGETS = \
415 mirrordocs \
416 docletapidocs \
417 tagletapidocs \
418 domapidocs \
419 jpdadocs \
420 jaasdocs \
421 jgssdocs \
422 smartcardiodocs \
423 httpserverdocs \
424 mgmtdocs \
425 attachdocs \
426 jconsoledocs \
427 treeapidocs
428
429.PHONY: all docs
430all docs: coredocs otherdocs
431
432.PHONY: otherdocs
433otherdocs: ${ALL_OTHER_TARGETS}
434
435
436#################################################################
437# Production Targets -- USE THESE TARGETS WHEN:
438# a) You're generating docs outside of release engineering's
439# standard control build.
440# b) The docs will be pushed to the web and/or included in
441# the downloaded doc bundle.
442#
443# See: Notes.html#releaseTargets
444# Note: Spaces preceed ifdef/ifndef indents. Tabs preceed target commands (!)
445#
446.PHONY: sanitycheckcoredocs
447sanitycheckcoredocs:
448 @$(ECHO) ""
449 @$(ECHO) "Building core api docs with these values:"
450 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
451 @$(ECHO) " MILESTONE = $(MILESTONE)"
452 @$(ECHO) ""
453 ifeq ($(BUILD_NUMBER), b00)
454 @$(ECHO) "ERROR: Build number must be defined"
455 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
456 @$(ECHO) ""
457 exit 1
458 endif
459
460# Maximize performance and ensure that build number & milestone are set.
461.PHONY: rel-coredocs
462rel-coredocs: sanitycheckcoredocs
463 @# ######## release version of core packages ########
464 $(MAKE) coredocs
465
466.PHONY: rel-docs
467rel-docs: rel-coredocs ${ALL_OTHER_TARGETS}
468#
469# end of production targets
470#############################################################
471
472.PHONY: coredocs
473coredocs:
474 @# ######## core packages #######################
475 $(RM) -r $(DOCSDIR)/api
476 $(MKDIR) -p $(DOCSDIR)/api
477 $(JAVADOC_CMD) $(CORE_JAVADOCFLAGS) \
478 -d $(DOCSDIR)/api \
479 -sourcepath $(RELEASEDOCS_SRCPATH) \
480 $(CORE_PKGS)
481
482.PHONY: mirrordocs
483mirrordocs:
484 @# ######## mirror api for apt ##################
485 $(RM) -r $(MIRROR_DESTDIR)
486 $(MKDIR) -p $(MIRROR_DESTDIR)
487 $(JAVADOC_CMD) $(MIRROR_JAVADOCFLAGS) \
488 -d $(MIRROR_DESTDIR) \
489 -sourcepath $(RELEASEDOCS_SRCPATH) \
490 $(MIRROR_LINKOPT) \
491 $(MIRROR_PKGS)
492
493.PHONY: docletapidocs
494docletapidocs:
495 @# ######## doclet api ############################
496 $(RM) -r $(DOCSDIR)/jdk/api/javadoc/doclet
497 $(MKDIR) -p $(DOCSDIR)/jdk/api/javadoc/doclet
498 $(JAVADOC_CMD) $(DOCLETAPI_JAVADOCFLAGS) \
499 -d $(DOCSDIR)/jdk/api/javadoc/doclet \
500 -sourcepath $(RELEASEDOCS_SRCPATH) \
501 $(DOCLETAPI_LINKOPT) \
502 $(DOCLETAPI_PKGS)
503
504.PHONY: tagletapidocs
505tagletapidocs:
506 @# ######## taglet api ############################
507 $(RM) -r $(DOCSDIR)/jdk/api/javadoc/taglet
508 $(MKDIR) -p $(DOCSDIR)/jdk/api/javadoc/taglet
509 $(RM) -r $(DOCSTMPDIR)
510 $(MKDIR) -p $(DOCSTMPDIR)
511 $(JAVADOC_CMD) $(TAGLETAPI_JAVADOCFLAGS) \
512 -d $(DOCSTMPDIR) \
513 -linkoffline ../../../../api $(DOCSDIR)/api/ \
514 $(IMPORTSRCDIR)/$(TAGLETAPI_FILE)
515 cp -r $(DOCSTMPDIR)/com $(DOCSDIR)/jdk/api/javadoc/taglet
516 cp $(DOCSTMPDIR)/stylesheet.css $(DOCSDIR)/jdk/api/javadoc/taglet
517 $(RM) -r $(DOCSTMPDIR)
518
519.PHONY: domapidocs
520domapidocs:
521 @# ######## dom api ############################
522 $(RM) -r $(DOCSDIR)/jre/api/plugin/dom
523 $(MKDIR) -p $(DOCSDIR)/jre/api/plugin/dom
524 $(JAVADOC_CMD) $(DOMAPI_JAVADOCFLAGS) \
525 -d $(DOCSDIR)/jre/api/plugin/dom \
526 -sourcepath $(RELEASEDOCS_SRCPATH) \
527 -linkoffline ../../../../api $(DOCSDIR)/api/ \
528 $(DOMAPI_PKGS)
529
530.PHONY: jpdadocs
531jpdadocs: jdidocs jdwpdocs jvmtidocs
532
533.PHONY: jdidocs
534jdidocs:
535 @# ######## jdi #################################
536 $(RM) -r $(DOCSDIR)/jdk/api/jpda/jdi
537 $(MKDIR) -p $(DOCSDIR)/jdk/api/jpda/jdi
538 $(JAVADOC_CMD) $(JDI_JAVADOCFLAGS) \
539 $(JDI_PKGS)
540
541JDWP_SPEC = $(BUILDDIR)/jpda/jdwp/jdwp.spec
542JDWP_DOC = $(DOCSDIR)/platform/jpda/jdwp/jdwp-protocol.html
543JDWPGEN_JARFILE = $(BUILDTOOLJARDIR)/jdwpgen.jar
544
545.PHONY: jdwpdocs
546jdwpdocs: $(JDWP_DOC)
547
548$(JDWP_DOC): $(JDWPGEN_JARFILE) $(JDWP_SPEC)
549 $(prep-target)
550 $(BOOT_JAVA_CMD) -jar $(JDWPGEN_JARFILE) $(JDWP_SPEC) -doc $(JDWP_DOC)
551
552.PHONY: jvmtidocs
553jvmtidocs:
554 @# ######## jvmti #################################
555 @if [ -f $(JVMTI_HTML) ] ; then \
556 $(RM) -r $(DOCSDIR)/$(JVMTI_DOCS_SUBDIR); \
557 $(MKDIR) -p $(DOCSDIR)/$(JVMTI_DOCS_SUBDIR); \
558 $(ECHO) $(CP) $(JVMTI_HTML) $(DOCSDIR)/$(JVMTI_DOCS_SUBDIR); \
559 $(CP) $(JVMTI_HTML) $(DOCSDIR)/$(JVMTI_DOCS_SUBDIR); \
560 else \
561 $(ECHO) "WARNING: Generated jvmti file does not exist: $(JVMTI_HTML)"; \
562 fi
563
564.PHONY: jaasdocs
565jaasdocs:
566 @# ######## api-jaas ############################
567 $(RM) -r $(JAAS_DOCDIR)
568 $(MKDIR) -p $(JAAS_DOCDIR)
569 $(JAVADOC_CMD) $(JAAS_JAVADOCFLAGS) \
570 $(JAAS_PKGS)
571
572.PHONY: jgssdocs
573jgssdocs:
574 @# ######## api-jgss ############################
575 $(RM) -r $(JGSS_DOCDIR)
576 $(MKDIR) -p $(JGSS_DOCDIR)
577 $(JAVADOC_CMD) $(JGSS_JAVADOCFLAGS) \
578 $(JGSS_PKGS)
579
580.PHONY: smartcardiodocs
581smartcardiodocs:
582 @# ######## api-smartcardio ############################
583 $(RM) -r $(SMARTCARDIO_DOCDIR)
584 $(MKDIR) -p $(SMARTCARDIO_DOCDIR)
585 $(JAVADOC_CMD) $(SMARTCARDIO_JAVADOCFLAGS) \
586 $(SMARTCARDIO_PKGS)
587
588.PHONY: httpserverdocs
589httpserverdocs:
590 @# ######## api-httpserver #######################
591 $(RM) -r $(HTTPSERVER_DOCDIR)
592 $(MKDIR) -p $(HTTPSERVER_DOCDIR)
593 $(JAVADOC_CMD) $(HTTPSERVER_JAVADOCFLAGS) \
594 $(HTTPSERVER_PKGS)
595
596.PHONY: mgmtdocs
597mgmtdocs: $(COPY-MIB-TARGET)
598 @# ######## api-management ############################
599 $(RM) -r $(MGMT_EXT_DIR)
600 $(MKDIR) -p $(MGMT_EXT_DIR)
601 $(JAVADOC_CMD) $(MGMT_JAVADOCFLAGS) \
602 $(MGMT_PKGS)
603
604copy-mib:
605 @# ######## copy-snmp-mib ############################
606 $(RM) $(MGMT_DOCDIR)/$(JVM_MIB_NAME)
607 $(MKDIR) -p $(MGMT_DOCDIR)
608 $(CP) $(JVM_MIB_SRC) $(MGMT_DOCDIR)
609
610.PHONY: attachdocs
611attachdocs:
612 @# ######## api-attach ############################
613 $(RM) -r $(ATTACH_DOCDIR)
614 $(MKDIR) -p $(ATTACH_DOCDIR)
615 $(JAVADOC_CMD) $(ATTACH_JAVADOCFLAGS) \
616 $(ATTACH_PKGS)
617
618.PHONY: jconsoledocs
619jconsoledocs:
620 @# ######## api-jconsole ############################
621 $(RM) -r $(JCONSOLE_DOCDIR)
622 $(MKDIR) -p $(JCONSOLE_DOCDIR)
623 $(JAVADOC_CMD) $(JCONSOLE_JAVADOCFLAGS) \
624 $(JCONSOLE_PKGS)
625
626.PHONY: treeapidocs
627treeapidocs:
628 @# ######## tree api for javac ##################
629 $(RM) -r $(TREEAPI_DESTDIR)
630 $(MKDIR) -p $(TREEAPI_DESTDIR)
631 $(JAVADOC_CMD) $(TREEAPI_JAVADOCFLAGS) \
632 -d $(TREEAPI_DESTDIR) \
633 -sourcepath $(RELEASEDOCS_SRCPATH) \
634 $(TREEAPI_LINKOPT) \
635 $(TREEAPI_PKGS)
636
637# DEBUG TARGET
638# List the values defined in the makefile hierarchy, to make sure everything
639# is set properly, and to help identify values we can use instead of making new ones.
640# (Most of them come from common/shared/Defs.gmk)
641#
642# Notes:
643# * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
644# * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
645#
646.PHONY: echovalues
647echovalues:
648 @$(ECHO) ""
649 @$(ECHO) --------------Shared---------------------------
650 @$(ECHO) BUILD_NUMBER = $(BUILD_NUMBER)
651 @$(ECHO) FULL_VERSION = $(FULL_VERSION)
652 @$(ECHO) JDK_VERSION = $(JDK_VERSION)
653 @$(ECHO) JDK_MAJOR_VERSION = $(JDK_MAJOR_VERSION)
654 @$(ECHO) JDK_MINOR_VERSION = $(JDK_MINOR_VERSION)
655 @$(ECHO) JDK_MICRO_VERSION = $(JDK_MICRO_VERSION)
656 @$(ECHO) JDK_UPDATE_VERSION = $(JDK_UPDATE_VERSION)
657 @$(ECHO) JDK_MKTG_VERSION = $(JDK_MKTG_VERSION)
658 @$(ECHO) JDK_UNDERSCORE_VERSION = $(JDK_UNDERSCORE_VERSION)
659 @$(ECHO) JDK_MKTG_UNDERSCORE_VERSION = $(JDK_MKTG_UNDERSCORE_VERSION)
660 @$(ECHO) MARKETING_NUMBER = $(MARKETING_NUMBER)
661 @$(ECHO) MARKET_NAME = $(MARKET_NAME)
662 @$(ECHO) MILESTONE = $(MILESTONE)
663 @$(ECHO) RELEASE = $(RELEASE)
664 @$(ECHO) USER_RELEASE_SUFFIX = $(USER_RELEASE_SUFFIX)
665 @$(ECHO) --------------Shared---------------------------
666 @$(ECHO) ""
667 @$(ECHO) --------------common/Defs---------------------------
668 @$(ECHO) "RELEASEDOCS_SRCPATH"
669 @$(ECHO) " SHARE_SRC/classes: $(SHARE_SRC)/classes"
670 @$(ECHO) " PLATFORM_SRC/classes: $(PLATFORM_SRC)/classes"
671 @$(ECHO) " GENSRCDIR: $(GENSRCDIR)"
672 @$(ECHO) " IMPORTSRCDIR: $(IMPORTSRCDIR)"
673 @$(ECHO) " SHARE_SRC/doc/stub: $(SHARE_SRC)/doc/stub"
674 @$(ECHO) --------------common/Defs---------------------------
675 @$(ECHO) ""