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