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