Context Navigation

← Previous Revision
Next Revision →
Blame
Revision Log

Makefile

Last change on this file was 278, checked in by dmik, 15 years ago
trunk: Merged in openjdk6 b22 from branches/vendor/oracle.
File size: 41.2 KB

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

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: trunk/openjdk/jdk/make/docs/Makefile

Download in other formats: