help.m4 revision 945:584dc2e95e04 
1#
2# Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# This code is free software; you can redistribute it and/or modify it
6# under the terms of the GNU General Public License version 2 only, as
7# published by the Free Software Foundation.  Oracle designates this
8# particular file as subject to the "Classpath" exception as provided
9# by Oracle in the LICENSE file that accompanied this code.
10#
11# This code is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14# version 2 for more details (a copy is included in the LICENSE file that
15# accompanied this code).
16#
17# You should have received a copy of the GNU General Public License version
18# 2 along with this work; if not, write to the Free Software Foundation,
19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20#
21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22# or visit www.oracle.com if you need additional information or have any
23# questions.
24#
25
26AC_DEFUN_ONCE([HELP_SETUP_DEPENDENCY_HELP],
27[
28    AC_CHECK_PROGS(PKGHANDLER, apt-get yum port pkgutil pkgadd)
29])
30
31AC_DEFUN([HELP_MSG_MISSING_DEPENDENCY],
32[
33    # Print a helpful message on how to acquire the necessary build dependency.
34    # $1 is the help tag: freetyp2, cups, pulse, alsa etc
35    MISSING_DEPENDENCY=$1
36    PKGHANDLER_COMMAND=
37
38    case $PKGHANDLER in
39	apt-get)
40                apt_help     $MISSING_DEPENDENCY ;;
41	yum)
42                yum_help     $MISSING_DEPENDENCY ;;
43	port)
44                port_help    $MISSING_DEPENDENCY ;;
45	pkgutil)
46                pkgutil_help $MISSING_DEPENDENCY ;;
47	pkgadd)
48                pkgadd_help  $MISSING_DEPENDENCY ;;
49    esac
50
51    if test "x$PKGHANDLER_COMMAND" != x; then
52        HELP_MSG="You might be able to fix this by running '$PKGHANDLER_COMMAND'."
53    fi
54])
55
56cygwin_help() {
57    case $1 in
58    unzip)
59        PKGHANDLER_COMMAND="cd <location of cygwin setup.exe> && cmd /c setup -q -P unzip" ;;
60    zip)
61        PKGHANDLER_COMMAND="cd <location of cygwin setup.exe> && cmd /c setup -q -P zip" ;;
62    make)
63        PKGHANDLER_COMMAND="cd <location of cygwin setup.exe> && cmd /c setup -q -P make" ;;
64    esac
65}
66
67apt_help() {
68    case $1 in
69    devkit)
70        PKGHANDLER_COMMAND="sudo apt-get install build-essential" ;;
71    openjdk)
72        PKGHANDLER_COMMAND="sudo apt-get install openjdk-7-jdk" ;;
73    alsa)
74        PKGHANDLER_COMMAND="sudo apt-get install libasound2-dev" ;;
75    cups)
76        PKGHANDLER_COMMAND="sudo apt-get install libcups2-dev" ;;
77    freetype2)
78        PKGHANDLER_COMMAND="sudo apt-get install libfreetype6-dev" ;;
79    pulse)
80        PKGHANDLER_COMMAND="sudo apt-get install libpulse-dev" ;;
81    x11)
82        PKGHANDLER_COMMAND="sudo apt-get install libX11-dev libxext-dev libxrender-dev libxtst-dev libxt-dev" ;;
83    ccache)
84        PKGHANDLER_COMMAND="sudo apt-get install ccache" ;;
85    esac
86}
87
88yum_help() {
89    case $1 in
90    devkit)
91        PKGHANDLER_COMMAND="sudo yum groupinstall \"Development Tools\"" ;;
92    openjdk)
93        PKGHANDLER_COMMAND="sudo yum install java-1.7.0-openjdk" ;;
94    alsa)
95        PKGHANDLER_COMMAND="sudo yum install alsa-lib-devel" ;;
96    cups)
97        PKGHANDLER_COMMAND="sudo yum install cups-devel" ;;
98    freetype2)
99        PKGHANDLER_COMMAND="sudo yum install freetype-devel" ;;
100    pulse)
101        PKGHANDLER_COMMAND="sudo yum install pulseaudio-libs-devel" ;;
102    x11)
103        PKGHANDLER_COMMAND="sudo yum install libXtst-devel libXt-devel libXrender-devel" ;;
104    ccache)
105        PKGHANDLER_COMMAND="sudo yum install ccache" ;;
106    esac
107}
108
109port_help() {
110    PKGHANDLER_COMMAND=""
111}
112
113pkgutil_help() {
114    PKGHANDLER_COMMAND=""
115}
116
117pkgadd_help() {
118    PKGHANDLER_COMMAND=""
119}
120
121AC_DEFUN_ONCE([HELP_PRINT_SUMMARY_AND_WARNINGS],
122[
123# Finally output some useful information to the user
124
125if test "x$CCACHE_FOUND" != x; then
126	if  test "x$HAS_GOOD_CCACHE" = x; then
127		CCACHE_STATUS="installed, but disabled (version older than 3.1.4)"
128		CCACHE_HELP_MSG="You have ccache installed, but it is a version prior to 3.1.4. Try upgrading."
129	else
130		CCACHE_STATUS="installed and in use"
131	fi
132else
133	if test "x$GCC" = xyes; then
134		CCACHE_STATUS="not installed (consider installing)"
135		CCACHE_HELP_MSG="You do not have ccache installed. Try installing it."
136	else
137		CCACHE_STATUS="not available for your system"
138	fi
139fi
140
141printf "\n"
142printf "====================================================\n"
143printf "A new configuration has been successfully created in\n"
144printf "$OUTPUT_ROOT\n"
145if test "x$CONFIGURE_COMMAND_LINE" != x; then
146	printf "using configure arguments '$CONFIGURE_COMMAND_LINE'.\n"
147else
148	printf "using default settings.\n"
149fi
150
151printf "\n"
152printf "Configuration summary:\n"
153printf "* Debug level:    $DEBUG_LEVEL\n"
154printf "* JDK variant:    $JDK_VARIANT\n"
155printf "* JVM variants:   $with_jvm_variants\n"
156printf "* OpenJDK target: OS: $OPENJDK_TARGET_OS, CPU architecture: $OPENJDK_TARGET_CPU_ARCH, address length: $OPENJDK_TARGET_CPU_BITS\n"
157
158printf "\n"
159printf "Tools summary:\n"
160if test "x$OPENJDK_BUILD_OS" = "xwindows"; then
161  printf "* Environment:    $WINDOWS_ENV_VENDOR version $WINDOWS_ENV_VERSION (root at $WINDOWS_ENV_ROOT_PATH)\n"
162fi
163printf "* Boot JDK:       $BOOT_JDK_VERSION (at $BOOT_JDK)\n"
164printf "* C Compiler:     $CC_VENDOR version $CC_VERSION (at $CC)\n"
165printf "* C++ Compiler:   $CXX_VENDOR version $CXX_VERSION (at $CXX)\n"
166
167printf "\n"
168printf "Build performance summary:\n"
169printf "* Cores to use:   $JOBS\n"
170printf "* Memory limit:   $MEMORY_SIZE MB\n"
171printf "* ccache status:  $CCACHE_STATUS\n"
172printf "\n"
173
174if test "x$CCACHE_HELP_MSG" != x && test "x$HIDE_PERFORMANCE_HINTS" = "xno"; then
175	printf "Build performance tip: ccache gives a tremendous speedup for C++ recompilations.\n"
176	printf "$CCACHE_HELP_MSG\n"
177	HELP_MSG_MISSING_DEPENDENCY([ccache])
178	printf "$HELP_MSG\n"
179	printf "\n"
180fi
181
182if test "x$BUILDING_MULTIPLE_JVM_VARIANTS" = "xyes"; then
183	printf "NOTE: You have requested to build more than one version of the JVM, which\n"
184	printf "will result in longer build times.\n"
185	printf "\n"
186fi
187
188if test "x$FOUND_ALT_VARIABLES" != "x"; then
189	printf "WARNING: You have old-style ALT_ environment variables set.\n"
190	printf "These are not respected, and will be ignored. It is recommended\n"
191	printf "that you clean your environment. The following variables are set:\n"
192	printf "$FOUND_ALT_VARIABLES\n"
193	printf "\n"
194fi
195
196if test "x$OUTPUT_DIR_IS_LOCAL" != "xyes"; then
197	printf "WARNING: Your build output directory is not on a local disk.\n"
198	printf "This will severely degrade build performance!\n"
199	printf "It is recommended that you create an output directory on a local disk,\n"
200	printf "and run the configure script again from that directory.\n"
201	printf "\n"
202fi
203
204if test "x$IS_RECONFIGURE" = "xyes"; then
205	printf "WARNING: The result of this configuration has overridden an older\n"
206	printf "configuration. You *should* run 'make clean' to make sure you get a\n"
207	printf "proper build. Failure to do so might result in strange build problems.\n"
208	printf "\n"
209fi
210])
211