# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation. Oracle designates this
# particular file as subject to the "Classpath" exception as provided
# by Oracle in the LICENSE file that accompanied this code.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#
#
# Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
#
BUILDDIR=..
# Get CopyrightLine macro and other shared variables
# Url to root of documents
# Url to copyright html file
# Url to bug filing site
# Common line for how to submit a bug or rfe
# Url to devdocs page
# Url to Java Language Spec
#JLS3_URL = http://java.sun.com/docs/books/jls/
# Common Java trademark line
#
# Definitions for imported components
#
# We override whatever the max VM memory setting is here.
# NOTE: javadoc will not complete without these larger settings.
# WARNING: This could cause thrashing on low memory machines.
else
# List of all possible directories for javadoc to look for sources
# NOTE: Quotes are required around sourcepath argument only on Windows.
# Otherwise, you get "No packages or classes specified." due
# to $(CLASSPATH_SEPARATOR) being interpreted as an end of
# command (newline or shell ; character)
$(IMPORTSRCDIR) \
$(GENSRCDIR) \
# List of directories that actually exist
# List with classpath separator between them
EMPTY:=
# Prep for javadoc creation, assumes $@ is an index.html file
@if [ -f "$@" -a "$?" != "" ] ; then \
$(ECHO) "# Dependencies have changed: $?"; \
fi
$(RM) -r $(@D)
$(MKDIR) -p $(@D)
# A cache of the directories in ALL_SOURCE_DIRS
# Given a list of packages, return a list of files or dirs to be dependent on
# (Currently only returning a list of directories)
$(shell \
for p in $1 ; do \
done; \
fi \
)
# Given a list of packages, add packages that exist to $@, print summary
@if [ "$1" != "" ] ; then \
for p in $1 ; do \
found="false"; \
$(ECHO) "$${p}" >> $@; \
found="true"; \
break; \
fi; \
done; \
if [ "$${found}" = "false" ] ; then \
$(ECHO) "WARNING: Package not found: $${p}"; \
fi; \
done; \
fi
# Print out a summary of the javadoc command about to be run
@$(ECHO) "# Summary for $@";\
#
# Temporary directory for javadoc creation
#
#
# Different api directories created from root directory
#
# The non-core api javadocs need to be able to access the root of the core
# directory we would use this:
# Common bottom argument
# Common trademark bottom argument (Not sure why this is used sometimes)
</font>
# Common echo of option
$(PRINTF) "%s\n" "$1"
# Core api bottom argument (with special sauce)
</font>
# Common javadoc options used by all
-quiet \
-use \
-keywords \
else
# Draft used for non-fcs documents
JDK_IS_FCS = false
JDK_IS_FCS = true
JDK_IS_FCS = true
# Early access top text (not used in FCS releases)
margin-left: 6px; margin-right: 6px; text-align: justify; \
font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
font-weight: normal;"> \
evaluation. \
#################################################################
#
# CORE_PKGS environment variable has been moved to the following file
#
#
# Load environment variables for API package names that are not part of
# the Java SE platform
#
#################################################################
#
# Default target is same as docs target, create core api and all others it can
#
#################################################################
# Production Targets -- USE THESE TARGETS WHEN:
# a) You're generating docs outside of release engineering's
# standard control build.
# the downloaded doc bundle.
#
# See: Notes.html#releaseTargets
#
@$(ECHO) ""
@$(ECHO) "Building core api docs with these values:"
@$(ECHO) ""
@$(ECHO) "ERROR: Build number must be defined"
@$(ECHO) ""
exit 1
#############################################################
#
# coredocs
#
COREAPI_HEADER = \
# Java language specification cite
# Overview file for core apis
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# mirrordocs
#
# Part of langtools
# MIRROR_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# docletapidocs
#
# Part of langtools
# DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# tagletapidocs
#
# Part of langtools
# TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
# Temporary directory (special generation rules)
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
$(RM) -r $(TAGLETAPI_TEMPDIR)
$(MKDIR) -p $(TAGLETAPI_TEMPDIR)
$(RM) -r $(TAGLETAPI_TEMPDIR)
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# domapidocs
#
# DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# jpdadocs
#
#############################################################
#
# jdidocs
#
# JDI_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
@$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
# Create file with javadoc options in it
$(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
) >> $@
# Create a file with the package names in it
#############################################################
#
# jdwpdocs
#
#############################################################
#
# jvmtidocs
#
@if [ -f $(JVMTI_HTML) ] ; then \
$(CP) $(JVMTI_HTML) $@; \
else \
fi
#############################################################
#
# jaasdocs
#
# JAAS_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
@$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
# Create file with javadoc options in it
$(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
) >> $@
# Create a file with the package names in it
#############################################################
#
# jgssdocs
#
# JGSS_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
@$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
# Create file with javadoc options in it
$(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
) >> $@
# Create a file with the package names in it
#############################################################
#
# smartcardiodocs
#
# SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# httpserverdocs
#
# HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# mgmtdocs
#
# MGMT_PKGS is located in NON_CORE_PKGS.gmk
# The index.html, options, and packages files
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
@if [ -f $(JVM_MIB_SRC) ] ; then \
else \
fi
@$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
# Create file with javadoc options in it
$(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
) >> $@
# Create a file with the package names in it
#############################################################
#
# attachdocs
#
# ATTACH_PKGS is located in NON_CORE_PKGS.gmk
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# jconsoledocs
#
# JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# treeapidocs
#
# Part of langtools
# TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# sctpdocs
#
# SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
# Set relative location to core api document root
# Run javadoc if the index file is out of date or missing
# Create file with javadoc options in it
) >> $@
# Create a file with the package names in it
#############################################################
#
# Get a cache of all the directories
done
#############################################################
#release version of core packages ########
# Maximize performance and ensure that build number & milestone are set.
#
# end of production targets
#############################################################
# DEBUG TARGET
# List the values defined in the makefile hierarchy, to make sure everything
# is set properly, and to help identify values we can use instead of making new ones.
#
# Notes:
# * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
# * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
#
#############################################################