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