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