make/Help.gmk
author herrick
Thu, 25 Jul 2019 08:24:01 -0400
branchJDK-8200758-branch
changeset 57532 eb0bd96672f4
parent 52595 16609197022c
child 58846 f9ac726ab347
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
     1
#
52342
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
     2
# Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
     3
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
fd16c54261b3 Initial load
duke
parents:
diff changeset
     4
#
fd16c54261b3 Initial load
duke
parents:
diff changeset
     5
# This code is free software; you can redistribute it and/or modify it
fd16c54261b3 Initial load
duke
parents:
diff changeset
     6
# under the terms of the GNU General Public License version 2 only, as
5499
eb0b3e373167 6943119: Rebrand source copyright notices
ohair
parents: 4309
diff changeset
     7
# published by the Free Software Foundation.  Oracle designates this
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
     8
# particular file as subject to the "Classpath" exception as provided
5499
eb0b3e373167 6943119: Rebrand source copyright notices
ohair
parents: 4309
diff changeset
     9
# by Oracle in the LICENSE file that accompanied this code.
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
    10
#
fd16c54261b3 Initial load
duke
parents:
diff changeset
    11
# This code is distributed in the hope that it will be useful, but WITHOUT
fd16c54261b3 Initial load
duke
parents:
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd16c54261b3 Initial load
duke
parents:
diff changeset
    13
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
fd16c54261b3 Initial load
duke
parents:
diff changeset
    14
# version 2 for more details (a copy is included in the LICENSE file that
fd16c54261b3 Initial load
duke
parents:
diff changeset
    15
# accompanied this code).
fd16c54261b3 Initial load
duke
parents:
diff changeset
    16
#
fd16c54261b3 Initial load
duke
parents:
diff changeset
    17
# You should have received a copy of the GNU General Public License version
fd16c54261b3 Initial load
duke
parents:
diff changeset
    18
# 2 along with this work; if not, write to the Free Software Foundation,
fd16c54261b3 Initial load
duke
parents:
diff changeset
    19
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
fd16c54261b3 Initial load
duke
parents:
diff changeset
    20
#
5499
eb0b3e373167 6943119: Rebrand source copyright notices
ohair
parents: 4309
diff changeset
    21
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
eb0b3e373167 6943119: Rebrand source copyright notices
ohair
parents: 4309
diff changeset
    22
# or visit www.oracle.com if you need additional information or have any
eb0b3e373167 6943119: Rebrand source copyright notices
ohair
parents: 4309
diff changeset
    23
# questions.
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
    24
#
fd16c54261b3 Initial load
duke
parents:
diff changeset
    25
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
    26
###
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
    27
### Global targets for printing help etc.
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
    28
###
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
    29
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    30
# Helper macro to allow $(info) to properly print strings beginning with spaces.
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    31
_:=
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    32
21759
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    33
help:
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    34
	$(info )
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    35
	$(info OpenJDK Makefile help)
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    36
	$(info =====================)
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    37
	$(info )
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    38
	$(info Common make targets)
47740
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    39
	$(info $(_) make [default]         # Compile all modules and create a runnable "exploded")
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    40
	$(info $(_)                        # image (alias for jdk or exploded-image))
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    41
	$(info $(_) make all               # Create all images: product, test, docs)
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    42
	$(info $(_)                        # (alias for all-images))
50490
cbae0e359538 8200132: Remove jre images and bundles
erikj
parents: 49979
diff changeset
    43
	$(info $(_) make images            # Create a complete jdk image)
47740
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    44
	$(info $(_)                        # (alias for product-images))
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    45
	$(info $(_) make <name>-image      # Build just the image for any of: )
50490
cbae0e359538 8200132: Remove jre images and bundles
erikj
parents: 49979
diff changeset
    46
	$(info $(_)                        # jdk, test, docs, symbols, legacy-jre)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    47
	$(info $(_) make <phase>           # Build the specified phase and everything it depends on)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    48
	$(info $(_)                        # (gensrc, java, copy, libs, launchers, gendata, rmic))
47740
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    49
	$(info $(_) make *-only            # Applies to most targets and disables building the)
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    50
	$(info $(_)                        # dependencies for that target. This is faster but may)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    51
	$(info $(_)                        # result in incorrect build results!)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    52
	$(info $(_) make docs              # Create all docs)
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44027
diff changeset
    53
	$(info $(_) make docs-jdk-api      # Create just JDK javadocs)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    54
	$(info $(_) make bootcycle-images  # Build images twice, second time with newly built JDK)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    55
	$(info $(_) make install           # Install the generated images locally)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    56
	$(info $(_) make reconfigure       # Rerun configure with the same arguments as last time)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    57
	$(info $(_) make help              # Give some help on using make)
52342
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
    58
	$(info $(_) make check             # Run basic testing (currently tier1))
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
    59
	$(info $(_) make test-<test>       # Run test, e.g. test-tier1)
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
    60
	$(info $(_) make test TEST=<t>     # Run test(s) given by TEST specification)
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
    61
	$(info $(_) make exploded-test TEST=<t> # Run test(s) on the exploded image instead of)
45266
29347d0c7122 8180651: Make target to run tests on exploded image
erikj
parents: 44726
diff changeset
    62
	$(info $(_)                        # the full jdk image)
21759
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    63
	$(info )
27560
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 26548
diff changeset
    64
	$(info Targets for cleaning)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    65
	$(info $(_) make clean             # Remove all files generated by make, but not those)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    66
	$(info $(_)                        # generated by configure)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    67
	$(info $(_) make dist-clean        # Remove all files, including configuration)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    68
	$(info $(_) make clean-<outputdir> # Remove the subdir in the output dir with the name)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    69
	$(info $(_) make clean-<phase>     # Remove all build results related to a certain build)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    70
	$(info $(_)                        # phase (gensrc, java, libs, launchers))
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    71
	$(info $(_) make clean-<module>    # Remove all build results related to a certain module)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    72
	$(info $(_) make clean-<module>-<phase> # Remove all build results related to a certain)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    73
	$(info $(_)                        # module and phase)
27560
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 26548
diff changeset
    74
	$(info )
42510
406dfb60de57 8170284: Move fine granular hotspot make targets to top level
erikj
parents: 41260
diff changeset
    75
	$(info Targets for Hotspot)
406dfb60de57 8170284: Move fine granular hotspot make targets to top level
erikj
parents: 41260
diff changeset
    76
	$(info $(_) make hotspot           # Build all of hotspot)
406dfb60de57 8170284: Move fine granular hotspot make targets to top level
erikj
parents: 41260
diff changeset
    77
	$(info $(_) make hotspot-<variant> # Build just the specified jvm variant)
406dfb60de57 8170284: Move fine granular hotspot make targets to top level
erikj
parents: 41260
diff changeset
    78
	$(info $(_) make hotspot-gensrc    # Only build the gensrc part of hotspot)
47740
fbf7a51ce32f 8190410: Help.gmk is not updated after consolidation
ihse
parents: 45266
diff changeset
    79
	$(info $(_) make hotspot-<variant>-<phase> # Build the specified phase for the variant)
42510
406dfb60de57 8170284: Move fine granular hotspot make targets to top level
erikj
parents: 41260
diff changeset
    80
	$(info )
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 22031
diff changeset
    81
	$(info Targets for specific modules)
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
    82
	$(info $(_) make <module>          # Build <module> and everything it depends on)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    83
	$(info $(_) make <module>-<phase>  # Compile the specified phase for the specified module)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    84
	$(info $(_)                        # and everything it depends on)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    85
	$(info $(_)                        # (gensrc, java, copy, libs, launchers, gendata, rmic))
21759
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
    86
	$(info )
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    87
	$(info Make control variables)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    88
	$(info $(_) CONF=                  # Build all configurations (note, assignment is empty))
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    89
	$(info $(_) CONF=<substring>       # Build the configuration(s) with a name matching)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    90
	$(info $(_)                        # <substring>)
34491
307c28cb36c2 8136782: Introduce a build/configure wrapper
erikj
parents: 29788
diff changeset
    91
	$(info $(_) CONF_NAME=<string>     # Build the configuration with exactly the <string>)
28902
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    92
	$(info $(_) SPEC=<spec file>       # Build the configuration given by the spec file)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    93
	$(info $(_) LOG=<loglevel>         # Change the log level from warn to <loglevel>)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    94
	$(info $(_)                        # Available log levels are:)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    95
	$(info $(_)                        # 'warn' (default), 'info', 'debug' and 'trace')
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    96
	$(info $(_)                        # To see executed command lines, use LOG=debug)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    97
	$(info $(_) JOBS=<n>               # Run <n> parallel make jobs)
0c09b47449c8 8069064: Various improvements and fixes in build system
ihse
parents: 28286
diff changeset
    98
	$(info $(_)                        # Note that -jN does not work as expected!)
34594
7e0595aab028 8139272: Add configure variable to set concurrency for jtreg tests
ehelin
parents: 34491
diff changeset
    99
	$(info $(_) TEST_JOBS=<n>          # Run <n> parallel test jobs)
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   100
	$(info $(_) CONF_CHECK=<method>    # What to do if spec file is out of date)
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   101
	$(info $(_)                        # method is 'auto', 'ignore' or 'fail' (default))
52342
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   102
	$(info $(_) TEST="test1 ..."       # Use the given test descriptor(s) for testing, e.g.)
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   103
	$(info $(_)                        # make test TEST="jdk_lang gtest:all")
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   104
	$(info $(_) JTREG="OPT1=x;OPT2=y"  # Control the JTREG test harness)
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   105
	$(info $(_) GTEST="OPT1=x;OPT2=y"  # Control the GTEST test harness)
52595
16609197022c 8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents: 52342
diff changeset
   106
	$(info $(_) MICRO="OPT1=x;OPT2=y"  # Control the MICRO test harness)
52342
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   107
	$(info $(_) TEST_OPTS="OPT1=x;..." # Generic control of all test harnesses)
9341b077bd55 8210958: Rename "make run-test" to "make test"
ihse
parents: 52125
diff changeset
   108
	$(info $(_) TEST_VM_OPTS="ARG ..." # Same as setting TEST_OPTS to VM_OPTIONS="ARG ...")
21759
e24e22311718 8027566: Remove the old build system
ihse
parents: 19758
diff changeset
   109
	$(info )
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   110
	$(if $(all_confs), $(info Available configurations in $(build_dir):) $(foreach var,$(all_confs),$(info * $(var))),\
29788
b581a3d9db41 8076465: New Init.gmk needs improvements
ihse
parents: 29662
diff changeset
   111
	    $(info No configurations were found in $(build_dir).) $(info Run 'bash configure' to create a configuration.))
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   112
        # We need a dummy rule otherwise make will complain
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   113
	@true
0
fd16c54261b3 Initial load
duke
parents:
diff changeset
   114
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   115
print-configurations:
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   116
	$(foreach var, $(all_confs), $(info $(var)))
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   117
        # We need a dummy rule otherwise make will complain
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   118
	@true
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   119
48078
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   120
# This is not really a "help" target, but it is a global target, and those are
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   121
# all contained in this file.
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   122
run-test-prebuilt:
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   123
	@( cd $(topdir) && \
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   124
	    $(MAKE) --no-print-directory -r -R -I make/common/ -f make/RunTestsPrebuilt.gmk \
52125
28375a1de254 8212028: Use run-test makefile framework for testing in Oracle's Mach5
erikj
parents: 50490
diff changeset
   125
	    run-test-prebuilt CUSTOM_MAKE_DIR=$(CUSTOM_MAKE_DIR) TEST="$(TEST)" )
48078
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   126
94a38ebbc9bb 8193061: Add run-test-prebuilt functionality
ihse
parents: 47740
diff changeset
   127
ALL_GLOBAL_TARGETS := help print-configurations run-test-prebuilt
29662
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   128
78c47f0002c3 8076060: Improve make bootstrap process
ihse
parents: 28902
diff changeset
   129
.PHONY: $(ALL_GLOBAL_TARGETS)