Help.gmk revision 2378:e75ac6a88841
1104349Sphk# 2104349Sphk# Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved. 3104349Sphk# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4104349Sphk# 5104349Sphk# This code is free software; you can redistribute it and/or modify it 6104349Sphk# under the terms of the GNU General Public License version 2 only, as 7104349Sphk# published by the Free Software Foundation. Oracle designates this 8104349Sphk# particular file as subject to the "Classpath" exception as provided 9104349Sphk# by Oracle in the LICENSE file that accompanied this code. 10104349Sphk# 11104349Sphk# This code is distributed in the hope that it will be useful, but WITHOUT 12104349Sphk# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13104349Sphk# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14104349Sphk# version 2 for more details (a copy is included in the LICENSE file that 15104349Sphk# accompanied this code). 16178848Scokane# 17178848Scokane# You should have received a copy of the GNU General Public License version 18178848Scokane# 2 along with this work; if not, write to the Free Software Foundation, 19178848Scokane# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20178848Scokane# 21178848Scokane# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22178848Scokane# or visit www.oracle.com if you need additional information or have any 23178848Scokane# questions. 24178848Scokane# 25178848Scokane 26178848Scokane### 27104349Sphk### Global targets for printing help etc. 28104349Sphk### 29104349Sphk 30104349Sphk# Helper macro to allow $(info) to properly print strings beginning with spaces. 31104349Sphk_:= 32104349Sphk 33104349Sphkhelp: 34104349Sphk $(info ) 35104349Sphk $(info OpenJDK Makefile help) 36104349Sphk $(info =====================) 37104349Sphk $(info ) 38104349Sphk $(info Common make targets) 39104349Sphk $(info $(_) make [default] # Compile all modules in langtools, hotspot, jdk, jaxws,) 40104349Sphk $(info $(_) # jaxp and corba, and create a runnable "exploded" image) 41104349Sphk $(info $(_) make all # Compile everything, all repos, docs and images) 42104349Sphk $(info $(_) make images # Create complete jdk and jre images (alias for product-images)) 43104349Sphk $(info $(_) make <name>-image # Build just the image (jdk, jre, test, docs etc)) 44178848Scokane $(info $(_) make <phase> # Build the specified phase and everything it depends on) 45178848Scokane $(info $(_) # (gensrc, java, copy, libs, launchers, gendata, rmic)) 46178848Scokane $(info $(_) make *-only # Applies to most targets and disables compling the) 47178848Scokane $(info $(_) # dependencies for the target. This is faster but may) 48178848Scokane $(info $(_) # result in incorrect build results!) 49178848Scokane $(info $(_) make docs # Create all docs) 50178848Scokane $(info $(_) make docs-javadoc # Create just javadocs, depends on less than full docs) 51104349Sphk $(info $(_) make profiles # Create complete jre compact profile images) 52104349Sphk $(info $(_) make bootcycle-images # Build images twice, second time with newly built JDK) 53104349Sphk $(info $(_) make install # Install the generated images locally) 54104349Sphk $(info $(_) make reconfigure # Rerun configure with the same arguments as last time) 55104349Sphk $(info $(_) make help # Give some help on using make) 56104349Sphk $(info $(_) make test # Run tests, default is all tests (see TEST below)) 57104349Sphk $(info ) 58104349Sphk $(info Targets for cleaning) 59104349Sphk $(info $(_) make clean # Remove all files generated by make, but not those) 60104349Sphk $(info $(_) # generated by configure) 61104349Sphk $(info $(_) make dist-clean # Remove all files, including configuration) 62104349Sphk $(info $(_) make clean-<outputdir> # Remove the subdir in the output dir with the name) 63104349Sphk $(info $(_) make clean-<phase> # Remove all build results related to a certain build) 64104349Sphk $(info $(_) # phase (gensrc, java, libs, launchers)) 65104349Sphk $(info $(_) make clean-<module> # Remove all build results related to a certain module) 66104349Sphk $(info $(_) make clean-<module>-<phase> # Remove all build results related to a certain) 67104349Sphk $(info $(_) # module and phase) 68104349Sphk $(info ) 69104349Sphk $(info Targets for Hotspot) 70104349Sphk $(info $(_) make hotspot # Build all of hotspot) 71104349Sphk $(info $(_) make hotspot-<variant> # Build just the specified jvm variant) 72104349Sphk $(info $(_) make hotspot-gensrc # Only build the gensrc part of hotspot) 73104349Sphk $(info $(_) make hotspot-<variant>-<phase> # Build the specified phase for the specified module) 74104349Sphk $(info ) 75178848Scokane $(info Targets for specific modules) 76178848Scokane $(info $(_) make <module> # Build <module> and everything it depends on) 77178848Scokane $(info $(_) make <module>-<phase> # Compile the specified phase for the specified module) 78104349Sphk $(info $(_) # and everything it depends on) 79104349Sphk $(info $(_) # (gensrc, java, copy, libs, launchers, gendata, rmic)) 80104349Sphk $(info ) 81104349Sphk $(info Make control variables) 82104349Sphk $(info $(_) CONF= # Build all configurations (note, assignment is empty)) 83104349Sphk $(info $(_) CONF=<substring> # Build the configuration(s) with a name matching) 84104349Sphk $(info $(_) # <substring>) 85104349Sphk $(info $(_) CONF_NAME=<string> # Build the configuration with exactly the <string>) 86104349Sphk $(info $(_) SPEC=<spec file> # Build the configuration given by the spec file) 87104349Sphk $(info $(_) LOG=<loglevel> # Change the log level from warn to <loglevel>) 88104349Sphk $(info $(_) # Available log levels are:) 89104349Sphk $(info $(_) # 'warn' (default), 'info', 'debug' and 'trace') 90104349Sphk $(info $(_) # To see executed command lines, use LOG=debug) 91104349Sphk $(info $(_) JOBS=<n> # Run <n> parallel make jobs) 92104349Sphk $(info $(_) # Note that -jN does not work as expected!) 93104349Sphk $(info $(_) TEST_JOBS=<n> # Run <n> parallel test jobs) 94178848Scokane $(info $(_) CONF_CHECK=<method> # What to do if spec file is out of date) 95104349Sphk $(info $(_) # method is 'auto', 'ignore' or 'fail' (default)) 96104349Sphk $(info $(_) make test TEST=<test> # Only run the given test or tests, e.g.) 97104349Sphk $(info $(_) # make test TEST="jdk_lang jdk_net") 98104349Sphk $(info ) 99104349Sphk $(if $(all_confs), $(info Available configurations in $(build_dir):) $(foreach var,$(all_confs),$(info * $(var))),\ 100104349Sphk $(info No configurations were found in $(build_dir).) $(info Run 'bash configure' to create a configuration.)) 101104349Sphk # We need a dummy rule otherwise make will complain 102104349Sphk @true 103104349Sphk 104104349Sphkprint-configurations: 105104349Sphk $(foreach var, $(all_confs), $(info $(var))) 106104349Sphk # We need a dummy rule otherwise make will complain 107104349Sphk @true 108104349Sphk 109104349SphkALL_GLOBAL_TARGETS := help print-configurations 110104349Sphk 111104349Sphk.PHONY: $(ALL_GLOBAL_TARGETS) 112104349Sphk