doc: pwd: improve the -P help description
[coreutils.git] / bootstrap
blob20913180a640e388153a994408bc249b59baae7c
1 #! /bin/sh
2 # DO NOT EDIT! GENERATED AUTOMATICALLY!
4 # Bootstrap this package from checked-out sources.
6 scriptversion=2024-04-13.15; # UTC
8 # Copyright (C) 2003-2024 Free Software Foundation, Inc.
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program. If not, see <https://www.gnu.org/licenses/>.
23 # Originally written by Paul Eggert. The canonical version of this
24 # script is maintained as top/bootstrap in gnulib. However, to be
25 # useful to your package, you should place a copy of it under version
26 # control in the top-level directory of your package. The intent is
27 # that all customization can be done with a bootstrap.conf file also
28 # maintained in your version control; gnulib comes with a template
29 # build-aux/bootstrap.conf to get you started.
31 # Please report bugs or propose patches to bug-gnulib@gnu.org.
33 me="$0"
34 medir=`dirname "$me"`
36 # Read the function library and the configuration.
38 # A library of shell functions for autopull.sh, autogen.sh, and bootstrap.
40 scriptlibversion=2024-04-13.15; # UTC
42 # Copyright (C) 2003-2024 Free Software Foundation, Inc.
44 # This program is free software: you can redistribute it and/or modify
45 # it under the terms of the GNU General Public License as published by
46 # the Free Software Foundation, either version 3 of the License, or
47 # (at your option) any later version.
49 # This program is distributed in the hope that it will be useful,
50 # but WITHOUT ANY WARRANTY; without even the implied warranty of
51 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
52 # GNU General Public License for more details.
54 # You should have received a copy of the GNU General Public License
55 # along with this program. If not, see <https://www.gnu.org/licenses/>.
57 # Originally written by Paul Eggert. The canonical version of this
58 # script is maintained as top/bootstrap-funclib.sh in gnulib. However,
59 # to be useful to your package, you should place a copy of it under
60 # version control in the top-level directory of your package. The
61 # intent is that all customization can be done with a bootstrap.conf
62 # file also maintained in your version control; gnulib comes with a
63 # template build-aux/bootstrap.conf to get you started.
65 nl='
68 # Ensure file names are sorted consistently across platforms.
69 LC_ALL=C
70 export LC_ALL
72 # Honor $PERL, but work even if there is none.
73 PERL="${PERL-perl}"
75 default_gnulib_url=https://git.savannah.gnu.org/git/gnulib.git
77 # Copyright year, for the --version output.
78 copyright_year=`echo "$scriptlibversion" | sed -e 's/[^0-9].*//'`
79 copyright="Copyright (C) ${copyright_year} Free Software Foundation, Inc.
80 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
81 This is free software: you are free to change and redistribute it.
82 There is NO WARRANTY, to the extent permitted by law."
84 # warnf_ FORMAT-STRING ARG1...
85 warnf_ ()
87 warnf_format_=$1
88 shift
89 nl='
91 case $* in
92 *$nl*) me_=$(printf "$me"|tr "$nl|" '??')
93 printf "$warnf_format_" "$@" | sed "s|^|$me_: |" ;;
94 *) printf "$me: $warnf_format_" "$@" ;;
95 esac >&2
98 # warn_ WORD1...
99 warn_ ()
101 # If IFS does not start with ' ', set it and emit the warning in a subshell.
102 case $IFS in
103 ' '*) warnf_ '%s\n' "$*";;
104 *) (IFS=' '; warn_ "$@");;
105 esac
108 # die WORD1...
109 die() { warn_ "$@"; exit 1; }
111 # ------------------------------ Configuration. ------------------------------
113 # Directory that contains package-specific gnulib modules and/or overrides.
114 local_gl_dir=gl
116 # Name of the Makefile.am
117 # XXX Not used.
118 gnulib_mk=gnulib.mk
120 # List of gnulib modules needed.
121 gnulib_modules=
123 # Any gnulib files needed that are not in modules.
124 gnulib_files=
126 # A function to be called for each unrecognized option. Returns 0 if
127 # the option in $1 has been processed by the function. Returns 1 if
128 # the option has not been processed by the function. Override it via
129 # your own definition in bootstrap.conf
130 bootstrap_option_hook() { return 1; }
132 # A function to be called in order to print the --help information
133 # corresponding to user-defined command-line options.
134 bootstrap_print_option_usage_hook() { :; }
136 # A function to be called at the end of autopull.sh.
137 # Override it via your own definition in bootstrap.conf.
138 bootstrap_post_pull_hook() { :; }
140 # A function to be called right after gnulib-tool is run.
141 # Override it via your own definition in bootstrap.conf.
142 bootstrap_post_import_hook() { :; }
144 # A function to be called after everything else in this script.
145 # Override it via your own definition in bootstrap.conf.
146 bootstrap_epilogue() { :; }
148 # The command to download all .po files for a specified domain into a
149 # specified directory. Fill in the first %s with the destination
150 # directory and the second with the domain name.
151 po_download_command_format=\
152 "wget --mirror --level=1 -nd -nv -A.po -P '%s' \
153 https://translationproject.org/latest/%s/"
155 # Prefer a non-empty tarname (4th argument of AC_INIT if given), else
156 # fall back to the package name (1st argument with munging).
157 extract_package_name='
158 /^AC_INIT(\[*/{
159 s///
160 /^[^,]*,[^,]*,[^,]*,[ []*\([^][ ,)]\)/{
161 s//\1/
162 s/[],)].*//
166 s/[],)].*//
167 s/^GNU //
168 y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/
169 s/[^abcdefghijklmnopqrstuvwxyz0123456789_]/-/g
173 package=$(${AUTOCONF:-autoconf} --trace AC_INIT:\$4 configure.ac 2>/dev/null)
174 if test -z "$package"; then
175 package=$(sed -n "$extract_package_name" configure.ac) \
176 || die 'cannot find package name in configure.ac'
178 gnulib_name=lib$package
180 build_aux=build-aux
181 source_base=lib
182 m4_base=m4
183 doc_base=doc
184 tests_base=tests
185 gnulib_extra_files="
186 build-aux/install-sh
187 build-aux/mdate-sh
188 build-aux/texinfo.tex
189 build-aux/depcomp
190 build-aux/config.guess
191 build-aux/config.sub
192 doc/INSTALL
195 # Additional gnulib-tool options to use. Use "\newline" to break lines.
196 gnulib_tool_option_extras=
198 # Other locale categories that need message catalogs.
199 EXTRA_LOCALE_CATEGORIES=
201 # Additional xgettext options to use. Use "\\\newline" to break lines.
202 XGETTEXT_OPTIONS='\\\
203 --flag=_:1:pass-c-format\\\
204 --flag=N_:1:pass-c-format\\\
205 --flag=error:3:c-format --flag=error_at_line:5:c-format\\\
208 # Package bug report address and copyright holder for gettext files
209 COPYRIGHT_HOLDER='Free Software Foundation, Inc.'
210 MSGID_BUGS_ADDRESS=bug-$package@gnu.org
212 # Files we don't want to import.
213 # XXX Not used.
214 excluded_files=
216 # File that should exist in the top directory of a checked out hierarchy,
217 # but not in a distribution tarball.
218 checkout_only_file=README-hacking
220 # Set this to '.cvsignore .gitignore' in bootstrap.conf if you want
221 # those files to be generated in directories like lib/, m4/, and po/.
222 # Or set it to 'auto' to make this script select which to use based
223 # on which version control system (if any) is used in the source directory.
224 vc_ignore=auto
226 # Set this to true in bootstrap.conf to enable --bootstrap-sync by
227 # default.
228 bootstrap_sync=false
230 # Override the default configuration, if necessary.
231 # Make sure that bootstrap.conf is sourced from the current directory
232 # if we were invoked as "sh bootstrap".
233 conffile=`dirname "$me"`/bootstrap.conf
234 test -r "$conffile" && . "$conffile"
236 # ------------------------- Build-time prerequisites -------------------------
238 check_exists() {
239 if test "$1" = "--verbose"; then
240 ($2 --version </dev/null) >/dev/null 2>&1
241 if test $? -ge 126; then
242 # If not found, run with diagnostics as one may be
243 # presented with env variables to set to find the right version
244 ($2 --version </dev/null)
246 else
247 ($1 --version </dev/null) >/dev/null 2>&1
250 test $? -lt 126
253 # Note this deviates from the version comparison in automake
254 # in that it treats 1.5 < 1.5.0, and treats 1.4.4a < 1.4-p3a
255 # but this should suffice as we won't be specifying old
256 # version formats or redundant trailing .0 in bootstrap.conf.
257 # If we did want full compatibility then we should probably
258 # use m4_version_compare from autoconf.
259 sort_ver() { # sort -V is not generally available
260 ver1="$1"
261 ver2="$2"
263 # split on '.' and compare each component
265 while : ; do
266 p1=$(echo "$ver1" | cut -d. -f$i)
267 p2=$(echo "$ver2" | cut -d. -f$i)
268 if [ ! "$p1" ]; then
269 echo "$1 $2"
270 break
271 elif [ ! "$p2" ]; then
272 echo "$2 $1"
273 break
274 elif [ ! "$p1" = "$p2" ]; then
275 if [ "$p1" -gt "$p2" ] 2>/dev/null; then # numeric comparison
276 echo "$2 $1"
277 elif [ "$p2" -gt "$p1" ] 2>/dev/null; then # numeric comparison
278 echo "$1 $2"
279 else # numeric, then lexicographic comparison
280 lp=$(printf "%s\n%s\n" "$p1" "$p2" | LANG=C sort -n | tail -n1)
281 if [ "$lp" = "$p2" ]; then
282 echo "$1 $2"
283 else
284 echo "$2 $1"
287 break
289 i=$(($i+1))
290 done
293 get_version_sed='
294 # Move version to start of line.
295 s/.*[v ]\([0-9]\)/\1/
297 # Skip lines that do not start with version.
298 /^[0-9]/!d
300 # Remove characters after the version.
301 s/[^.a-z0-9-].*//
303 # The first component must be digits only.
304 s/^\([0-9]*\)[a-z-].*/\1/
306 #the following essentially does s/5.005/5.5/
307 s/\.0*\([1-9]\)/.\1/g
311 get_version() {
312 app=$1
314 $app --version >/dev/null 2>&1 || { $app --version; return 1; }
316 $app --version 2>&1 | sed -n "$get_version_sed"
319 check_versions() {
320 ret=0
322 while read app req_ver; do
323 # We only need libtoolize from the libtool package.
324 if test "$app" = libtool; then
325 app=libtoolize
327 # Exempt git if git is not needed.
328 if test "$app" = git; then
329 $check_git || continue
331 # Honor $APP variables ($TAR, $AUTOCONF, etc.)
332 appvar=$(echo $app | LC_ALL=C tr '[a-z]-' '[A-Z]_')
333 test "$appvar" = TAR && appvar=AMTAR
334 case $appvar in
335 GZIP) ;; # Do not use $GZIP: it contains gzip options.
336 PERL::*) ;; # Keep perl modules as-is
337 *) eval "app=\${$appvar-$app}" ;;
338 esac
340 # Handle the still-experimental Automake-NG programs specially.
341 # They remain named as the mainstream Automake programs ("automake",
342 # and "aclocal") to avoid gratuitous incompatibilities with
343 # preexisting usages (by, say, autoreconf, or custom autogen.sh
344 # scripts), but correctly identify themselves (as being part of
345 # "GNU automake-ng") when asked their version.
346 case $app in
347 automake-ng|aclocal-ng)
348 app=${app%-ng}
349 ($app --version | grep '(GNU automake-ng)') >/dev/null 2>&1 || {
350 warn_ "Error: '$app' not found or not from Automake-NG"
351 ret=1
352 continue
353 } ;;
354 # Another check is for perl modules. These can be written as
355 # e.g. perl::XML::XPath in case of XML::XPath module, etc.
356 perl::*)
357 # Extract module name
358 app="${app#perl::}"
359 if ! $PERL -m"$app" -e 'exit 0' >/dev/null 2>&1; then
360 warn_ "Error: perl module '$app' not found"
361 ret=1
363 continue
365 esac
366 if [ "$req_ver" = "-" ]; then
367 # Merely require app to exist; not all prereq apps are well-behaved
368 # so we have to rely on $? rather than get_version.
369 if ! check_exists --verbose $app; then
370 warn_ "Error: '$app' not found"
371 ret=1
373 else
374 # Require app to produce a new enough version string.
375 inst_ver=$(get_version $app)
376 if [ ! "$inst_ver" ]; then
377 warn_ "Error: '$app' not found"
378 ret=1
379 else
380 latest_ver=$(sort_ver $req_ver $inst_ver | cut -d' ' -f2)
381 if [ ! "$latest_ver" = "$inst_ver" ]; then
382 warnf_ '%s\n' \
383 "Error: '$app' version == $inst_ver is too old" \
384 " '$app' version >= $req_ver is required"
385 ret=1
389 done
391 return $ret
394 print_versions() {
395 echo "Program Min_version"
396 echo "----------------------"
397 printf %s "$buildreq"
398 echo "----------------------"
399 # can't depend on column -t
402 # check_build_prerequisites check_git
403 check_build_prerequisites()
405 check_git="$1"
407 # gnulib-tool requires at least automake and autoconf.
408 # If either is not listed, add it (with minimum version) as a prerequisite.
409 case $buildreq in
410 *automake*) ;;
411 *) buildreq="automake 1.9
412 $buildreq" ;;
413 esac
414 case $buildreq in
415 *autoconf*) ;;
416 *) buildreq="autoconf 2.59
417 $buildreq" ;;
418 esac
420 # When we can deduce that gnulib-tool will require patch,
421 # and when patch is not already listed as a prerequisite, add it, too.
422 if test -d "$local_gl_dir" \
423 && ! find "$local_gl_dir" -name '*.diff' -exec false {} +; then
424 case $buildreq in
425 *patch*) ;;
426 *) buildreq="patch -
427 $buildreq" ;;
428 esac
431 if ! printf '%s' "$buildreq" | check_versions; then
432 echo >&2
433 if test -f README-prereq; then
434 die "See README-prereq for how to get the prerequisite programs"
435 else
436 die "Please install the prerequisite programs"
440 # Warn the user if autom4te appears to be broken; this causes known
441 # issues with at least gettext 0.18.3.
442 probe=$(echo 'm4_quote([hi])' | autom4te -l M4sugar -t 'm4_quote:$%' -)
443 if test "x$probe" != xhi; then
444 warn_ "WARNING: your autom4te wrapper eats stdin;"
445 warn_ "if bootstrap fails, consider upgrading your autotools"
449 # find_tool ENVVAR NAMES...
450 # -------------------------
451 # Search for a required program. Use the value of ENVVAR, if set,
452 # otherwise find the first of the NAMES that can be run.
453 # If found, set ENVVAR to the program name, die otherwise.
455 # FIXME: code duplication, see also gnu-web-doc-update.
456 find_tool ()
458 find_tool_envvar=$1
459 shift
460 find_tool_names=$@
461 eval "find_tool_res=\$$find_tool_envvar"
462 if test x"$find_tool_res" = x; then
463 for i; do
464 if check_exists $i; then
465 find_tool_res=$i
466 break
468 done
470 if test x"$find_tool_res" = x; then
471 warn_ "one of these is required: $find_tool_names;"
472 die "alternatively set $find_tool_envvar to a compatible tool"
474 eval "$find_tool_envvar=\$find_tool_res"
475 eval "export $find_tool_envvar"
478 # --------------------- Preparing GNULIB_SRCDIR for use. ---------------------
479 # This is part of autopull.sh, but bootstrap needs it too, for self-upgrading.
481 # cleanup_gnulib fails, removing the directory $gnulib_path first.
482 cleanup_gnulib() {
483 status=$?
484 rm -fr "$gnulib_path"
485 exit $status
488 git_modules_config () {
489 test -f .gitmodules && git config --file .gitmodules "$@"
492 prepare_GNULIB_SRCDIR ()
494 if test -n "$GNULIB_SRCDIR"; then
495 # Use GNULIB_SRCDIR directly.
496 # We already checked that $GNULIB_SRCDIR references a directory.
497 # Verify that it contains a gnulib checkout.
498 test -f "$GNULIB_SRCDIR/gnulib-tool" \
499 || die "Error: --gnulib-srcdir or \$GNULIB_SRCDIR is specified," \
500 "but does not contain gnulib-tool"
501 if test -n "$GNULIB_REVISION" && $use_git; then
502 (cd "$GNULIB_SRCDIR" && git checkout "$GNULIB_REVISION") || exit $?
504 else
505 if ! $use_git; then
506 die "Error: --no-git is specified," \
507 "but neither --gnulib-srcdir nor \$GNULIB_SRCDIR is specified"
509 if git submodule -h | grep -- --reference > /dev/null; then
511 else
512 die "git version is too old, git >= 1.6.4 is required"
514 gnulib_path=$(git_modules_config submodule.gnulib.path)
515 if test -n "$gnulib_path"; then
516 # A submodule 'gnulib' is configured.
517 # Get gnulib files. Populate $gnulib_path, updating the submodule.
518 if test -n "$GNULIB_REFDIR" && test -d "$GNULIB_REFDIR"/.git; then
519 # Use GNULIB_REFDIR as a reference.
520 echo "$0: getting gnulib files..."
521 git submodule update --init --reference "$GNULIB_REFDIR" "$gnulib_path" \
522 || exit $?
523 else
524 # GNULIB_REFDIR is not set or not usable. Ignore it.
525 if git_modules_config submodule.gnulib.url >/dev/null; then
526 echo "$0: getting gnulib files..."
527 git submodule init -- "$gnulib_path" || exit $?
528 git submodule update -- "$gnulib_path" || exit $?
529 else
530 die "Error: submodule 'gnulib' has no configured url"
533 else
534 gnulib_path='gnulib'
535 if test ! -d "$gnulib_path"; then
536 # The subdirectory 'gnulib' does not yet exist. Clone into it.
537 echo "$0: getting gnulib files..."
538 trap cleanup_gnulib HUP INT PIPE TERM
539 shallow=
540 if test -z "$GNULIB_REVISION"; then
541 if git clone -h 2>&1 | grep -- --depth > /dev/null; then
542 shallow='--depth 2'
544 git clone $shallow ${GNULIB_URL:-$default_gnulib_url} "$gnulib_path" \
545 || cleanup_gnulib
546 else
547 if git fetch -h 2>&1 | grep -- --depth > /dev/null; then
548 shallow='--depth 2'
550 mkdir -p "$gnulib_path"
551 # Only want a shallow checkout of $GNULIB_REVISION, but git does not
552 # support cloning by commit hash. So attempt a shallow fetch by commit
553 # hash to minimize the amount of data downloaded and changes needed to
554 # be processed, which can drastically reduce download and processing
555 # time for checkout. If the fetch by commit fails, a shallow fetch can
556 # not be performed because we do not know what the depth of the commit
557 # is without fetching all commits. So fall back to fetching all
558 # commits.
559 git -C "$gnulib_path" init
560 git -C "$gnulib_path" remote add origin ${GNULIB_URL:-$default_gnulib_url}
561 git -C "$gnulib_path" fetch $shallow origin "$GNULIB_REVISION" \
562 || git -C "$gnulib_path" fetch origin \
563 || cleanup_gnulib
564 git -C "$gnulib_path" reset --hard FETCH_HEAD
565 (cd "$gnulib_path" && git checkout "$GNULIB_REVISION") || cleanup_gnulib
567 trap - HUP INT PIPE TERM
568 else
569 # The subdirectory 'gnulib' already exists.
570 if test -n "$GNULIB_REVISION"; then
571 if test -d "$gnulib_path/.git"; then
572 (cd "$gnulib_path" && git checkout "$GNULIB_REVISION") || exit 1
573 else
574 die "Error: GNULIB_REVISION is specified in bootstrap.conf," \
575 "but '$gnulib_path' contains no git history"
580 # Verify that $gnulib_path contains a gnulib checkout.
581 test -f "$gnulib_path/gnulib-tool" \
582 || die "Error: '$gnulib_path' is supposed to contain a gnulib checkout," \
583 "but does not contain gnulib-tool"
584 GNULIB_SRCDIR=$gnulib_path
586 # $GNULIB_SRCDIR now points to the version of gnulib to use, and
587 # we no longer need to use git or $gnulib_path below here.
590 # -------- Upgrading bootstrap to the version found in GNULIB_SRCDIR. --------
592 upgrade_bootstrap ()
594 if test -f "$medir"/bootstrap-funclib.sh; then
595 update_lib=true
596 { cmp -s "$medir"/bootstrap "$GNULIB_SRCDIR/top/bootstrap" \
597 && cmp -s "$medir"/bootstrap-funclib.sh \
598 "$GNULIB_SRCDIR/top/bootstrap-funclib.sh" \
599 && cmp -s "$medir"/autopull.sh "$GNULIB_SRCDIR/top/autopull.sh" \
600 && cmp -s "$medir"/autogen.sh "$GNULIB_SRCDIR/top/autogen.sh"; \
602 else
603 update_lib=false
604 cmp -s "$medir"/bootstrap "$GNULIB_SRCDIR/build-aux/bootstrap"
605 fi || {
606 if $update_lib; then
607 echo "$0: updating bootstrap & companions and restarting..."
608 else
609 echo "$0: updating bootstrap and restarting..."
611 case $(sh -c 'echo "$1"' -- a) in
612 a) ignored=--;;
613 *) ignored=ignored;;
614 esac
615 u=$update_lib
616 exec sh -c \
617 '{ if '$u' && test -f "$1"; then cp "$1" "$3"; else cp "$2" "$3"; fi; } &&
618 { if '$u' && test -f "$4"; then cp "$4" "$5"; else rm -f "$5"; fi; } &&
619 { if '$u' && test -f "$6"; then cp "$6" "$7"; else rm -f "$7"; fi; } &&
620 { if '$u' && test -f "$8"; then cp "$8" "$9"; else rm -f "$9"; fi; } &&
621 shift && shift && shift && shift && shift &&
622 shift && shift && shift && shift &&
623 exec "${CONFIG_SHELL-/bin/sh}" "$@"' \
624 $ignored \
625 "$GNULIB_SRCDIR/top/bootstrap" "$GNULIB_SRCDIR/build-aux/bootstrap" \
626 "$medir/bootstrap" \
627 "$GNULIB_SRCDIR/top/bootstrap-funclib.sh" "$medir/bootstrap-funclib.sh" \
628 "$GNULIB_SRCDIR/top/autopull.sh" "$medir/autopull.sh" \
629 "$GNULIB_SRCDIR/top/autogen.sh" "$medir/autogen.sh" \
630 "$0" "$@" --no-bootstrap-sync
634 # ----------------------------------------------------------------------------
636 if test x"$gnulib_modules$gnulib_files$gnulib_extra_files" = x; then
637 use_gnulib=false
638 else
639 use_gnulib=true
642 # -------- Fetch auxiliary files from the network. --------------------------
644 autopull_usage() {
645 cat <<EOF
646 Usage: $me [OPTION]...
647 Bootstrap this package from the checked-out sources, phase 1:
648 Pull files from the network.
650 Optional environment variables:
651 GNULIB_SRCDIR Specifies the local directory where gnulib
652 sources reside. Use this if you already
653 have gnulib sources on your machine, and
654 you want to use these sources.
655 GNULIB_REFDIR Specifies the local directory where a gnulib
656 repository (with a .git subdirectory) resides.
657 Use this if you already have gnulib sources
658 and history on your machine, and do not want
659 to waste your bandwidth downloading them again.
660 GNULIB_URL URL of the gnulib repository. The default is
661 $default_gnulib_url,
662 which is Gnulib's upstream repository.
664 Options:
666 --bootstrap-sync If this bootstrap script is not identical to
667 the version in the local gnulib sources,
668 update this script, and then restart it with
669 /bin/sh or the shell \$CONFIG_SHELL.
670 --no-bootstrap-sync Do not check whether bootstrap is out of sync.
672 --force Attempt to bootstrap even if the sources seem
673 not to have been checked out.
674 --no-git Do not use git to update gnulib. Requires that
675 \$GNULIB_SRCDIR points to a gnulib repository
676 with the correct revision.
677 --skip-po Do not download *.po files.
679 bootstrap_print_option_usage_hook
680 cat <<EOF
681 If the file bootstrap.conf exists in the same directory as this script, its
682 contents are read as shell variables to configure the bootstrap.
684 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
685 are honored.
687 Gnulib sources can be fetched in various ways:
689 * If the environment variable GNULIB_SRCDIR is set, then sources are
690 fetched from that local directory. If it is a git repository and the
691 configuration variable GNULIB_REVISION is set in bootstrap.conf, then
692 that revision is checked out.
694 * Otherwise, if this package is in a git repository with a 'gnulib'
695 submodule configured, then that submodule is initialized and updated
696 and sources are fetched from there. If the environment variable
697 GNULIB_REFDIR is set and is a git repository, then it is used as a
698 reference.
700 * Otherwise, if the 'gnulib' directory does not exist, Gnulib sources
701 are cloned into that directory using git from \$GNULIB_URL, defaulting
702 to $default_gnulib_url.
703 If the configuration variable GNULIB_REVISION is set in bootstrap.conf,
704 then that revision is checked out.
706 * Otherwise, the existing Gnulib sources in the 'gnulib' directory are
707 used. If it is a git repository and the configuration variable
708 GNULIB_REVISION is set in bootstrap.conf, then that revision is
709 checked out.
711 If you maintain a package and want to pin a particular revision of the
712 Gnulib sources that has been tested with your package, then there are
713 two possible approaches: either configure a 'gnulib' submodule with the
714 appropriate revision, or set GNULIB_REVISION (and if necessary
715 GNULIB_URL) in bootstrap.conf.
717 Running without arguments will suffice in most cases.
721 # Fetch auxiliary files that are omitted from the version control
722 # repository of this package.
723 autopull()
725 # Ensure that CDPATH is not set. Otherwise, the output from cd
726 # would cause trouble in at least one use below.
727 (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
729 # Parse options.
731 # Use git to update gnulib sources
732 use_git=true
734 for option
736 case $option in
737 --help)
738 autopull_usage
739 return;;
740 --version)
741 set -e
742 echo "autopull.sh $scriptlibversion"
743 echo "$copyright"
744 return 0
746 --skip-po)
747 SKIP_PO=t;;
748 --force)
749 checkout_only_file=;;
750 --bootstrap-sync)
751 bootstrap_sync=true;;
752 --no-bootstrap-sync)
753 bootstrap_sync=false;;
754 --no-git)
755 use_git=false;;
757 bootstrap_option_hook $option || die "$option: unknown option";;
758 esac
759 done
761 $use_git || test -n "$GNULIB_SRCDIR" \
762 || die "Error: --no-git requires \$GNULIB_SRCDIR environment variable" \
763 "or --gnulib-srcdir option"
764 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
765 || die "Error: \$GNULIB_SRCDIR environment variable" \
766 "or --gnulib-srcdir option is specified," \
767 "but does not denote a directory"
769 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
770 die "Running this script from a non-checked-out distribution is risky."
773 check_build_prerequisites $use_git
775 if $use_gnulib || $bootstrap_sync; then
776 prepare_GNULIB_SRCDIR
777 if $bootstrap_sync; then
778 upgrade_bootstrap "$@"
782 # Find sha1sum, named gsha1sum on MacPorts, shasum on Mac OS X 10.6.
783 # Also find the compatible sha1 utility on the BSDs
784 if test x"$SKIP_PO" = x; then
785 find_tool SHA1SUM sha1sum gsha1sum shasum sha1
788 # See if we can use gnulib's git-merge-changelog merge driver.
789 if $use_git && test -d .git && check_exists git; then
790 if git config merge.merge-changelog.driver >/dev/null ; then
792 elif check_exists git-merge-changelog; then
793 echo "$0: initializing git-merge-changelog driver"
794 git config merge.merge-changelog.name 'GNU-style ChangeLog merge driver'
795 git config merge.merge-changelog.driver 'git-merge-changelog %O %A %B'
796 else
797 echo "$0: consider installing git-merge-changelog from gnulib"
801 case $SKIP_PO in
803 if test -d po; then
804 update_po_files po $package || return
807 if test -d runtime-po; then
808 update_po_files runtime-po $package-runtime || return
809 fi;;
810 esac
812 # ---------------------------------------------------------------------------
814 bootstrap_post_pull_hook \
815 || die "bootstrap_post_pull_hook failed"
817 # Don't proceed if there are uninitialized submodules. In particular,
818 # autogen.sh will remove dangling links, which might be links into
819 # uninitialized submodules.
820 # But it's OK if the 'gnulib' submodule is uninitialized, as long as
821 # GNULIB_SRCDIR is set.
822 if $use_git; then
823 # Uninitialized submodules are listed with an initial dash.
824 uninitialized=`git submodule | grep '^-' | awk '{ print $2 }'`
825 if test -n "$GNULIB_SRCDIR"; then
826 uninitialized=`echo "$uninitialized" | grep -v '^gnulib$'`
828 if test -n "$uninitialized"; then
829 uninit_comma=`echo "$uninitialized" | tr '\n' ',' | sed -e 's|,$|.|'`
830 die "Some git submodules are not initialized: "$uninit_comma \
831 "Either use option '--no-git'," \
832 "or run 'git submodule update --init' and bootstrap again."
836 if test -f "$medir"/autogen.sh; then
837 echo "$0: done. Now you can run '$medir/autogen.sh'."
841 # ----------------------------- Get translations. -----------------------------
843 download_po_files() {
844 subdir=$1
845 domain=$2
846 echo "$me: getting translations into $subdir for $domain..."
847 cmd=$(printf "$po_download_command_format" "$subdir" "$domain")
848 eval "$cmd"
851 # Mirror .po files to $po_dir/.reference and copy only the new
852 # or modified ones into $po_dir. Also update $po_dir/LINGUAS.
853 # Note po files that exist locally only are left in $po_dir but will
854 # not be included in LINGUAS and hence will not be distributed.
855 update_po_files() {
856 # Directory containing primary .po files.
857 # Overwrite them only when we're sure a .po file is new.
858 po_dir=$1
859 domain=$2
861 # Mirror *.po files into this dir.
862 # Usually contains *.s1 checksum files.
863 ref_po_dir="$po_dir/.reference"
865 test -d $ref_po_dir || mkdir $ref_po_dir || return
866 download_po_files $ref_po_dir $domain \
867 && ls "$ref_po_dir"/*.po 2>/dev/null |
868 sed 's|.*/||; s|\.po$||' > "$po_dir/LINGUAS" || return
870 langs=$(cd $ref_po_dir && echo *.po | sed 's/\.po//g')
871 test "$langs" = '*' && langs=x
872 for po in $langs; do
873 case $po in x) continue;; esac
874 new_po="$ref_po_dir/$po.po"
875 cksum_file="$ref_po_dir/$po.s1"
876 if ! test -f "$cksum_file" ||
877 ! test -f "$po_dir/$po.po" ||
878 ! $SHA1SUM -c "$cksum_file" < "$new_po" > /dev/null 2>&1; then
879 echo "$me: updated $po_dir/$po.po..."
880 cp "$new_po" "$po_dir/$po.po" \
881 && $SHA1SUM < "$new_po" > "$cksum_file" || return
883 done
886 # -------- Generate files automatically from existing sources. --------------
888 autogen_usage() {
889 cat <<EOF
890 Usage: $me [OPTION]...
891 Bootstrap this package from the checked-out sources, phase 2:
892 Generate files from local files (no network access).
894 Optional environment variables:
895 GNULIB_SRCDIR Specifies the local directory where gnulib
896 sources reside. Use this if you already
897 have gnulib sources on your machine, and
898 you want to use these sources.
900 Options:
901 --copy Copy files instead of creating symbolic links.
902 --force Attempt to bootstrap even if the sources seem
903 not to have been checked out.
905 bootstrap_print_option_usage_hook
906 cat <<EOF
907 If the file bootstrap.conf exists in the same directory as this script, its
908 contents are read as shell variables to configure the bootstrap.
910 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
911 are honored.
913 Gnulib sources are assumed to be present:
914 * in \$GNULIB_SRCDIR, if that environment variable is set,
915 * otherwise, in the 'gnulib' submodule, if such a submodule is configured,
916 * otherwise, in the 'gnulib' subdirectory.
918 Running without arguments will suffice in most cases.
923 version_controlled_file() {
924 parent=$1
925 file=$2
926 if test -d .git; then
927 git rm -n "$file" > /dev/null 2>&1
928 elif test -d .svn; then
929 svn log -r HEAD "$file" > /dev/null 2>&1
930 elif test -d CVS; then
931 grep -F "/${file##*/}/" "$parent/CVS/Entries" 2>/dev/null |
932 grep '^/[^/]*/[0-9]' > /dev/null
933 else
934 warn_ "no version control for $file?"
935 false
939 # Strip blank and comment lines to leave significant entries.
940 gitignore_entries() {
941 sed '/^#/d; /^$/d' "$@"
944 # If $STR is not already on a line by itself in $FILE, insert it at the start.
945 # Entries are inserted at the start of the ignore list to ensure existing
946 # entries starting with ! are not overridden. Such entries support
947 # whitelisting exceptions after a more generic blacklist pattern.
948 insert_if_absent() {
949 file=$1
950 str=$2
951 test -f $file || touch $file
952 test -r $file || die "Error: failed to read ignore file: $file"
953 duplicate_entries=$(gitignore_entries $file | sort | uniq -d)
954 if [ "$duplicate_entries" ] ; then
955 die "Error: Duplicate entries in $file: " $duplicate_entries
957 linesold=$(gitignore_entries $file | wc -l)
958 linesnew=$( { echo "$str"; cat $file; } | gitignore_entries | sort -u | wc -l)
959 if [ $linesold != $linesnew ] ; then
960 { echo "$str" | cat - $file > $file.bak && mv $file.bak $file; } \
961 || die "insert_if_absent $file $str: failed"
965 # Adjust $PATTERN for $VC_IGNORE_FILE and insert it with
966 # insert_if_absent.
967 insert_vc_ignore() {
968 vc_ignore_file="$1"
969 pattern="$2"
970 case $vc_ignore_file in
971 *.gitignore)
972 # A .gitignore entry that does not start with '/' applies
973 # recursively to subdirectories, so prepend '/' to every
974 # .gitignore entry.
975 pattern=$(echo "$pattern" | sed s,^,/,);;
976 esac
977 insert_if_absent "$vc_ignore_file" "$pattern"
980 symlink_to_dir()
982 src=$1/$2
983 dst=${3-$2}
985 test -f "$src" && {
987 # If the destination directory doesn't exist, create it.
988 # This is required at least for "lib/uniwidth/cjk.h".
989 dst_dir=$(dirname "$dst")
990 if ! test -d "$dst_dir"; then
991 mkdir -p "$dst_dir"
993 # If we've just created a directory like lib/uniwidth,
994 # tell version control system(s) it's ignorable.
995 # FIXME: for now, this does only one level
996 parent=$(dirname "$dst_dir")
997 for dot_ig in x $vc_ignore; do
998 test $dot_ig = x && continue
999 ig=$parent/$dot_ig
1000 insert_vc_ignore $ig "${dst_dir##*/}/"
1001 done
1004 if $copy; then
1006 test ! -h "$dst" || {
1007 echo "$me: rm -f $dst" &&
1008 rm -f "$dst"
1010 } &&
1011 test -f "$dst" &&
1012 cmp -s "$src" "$dst" || {
1013 echo "$me: cp -fp $src $dst" &&
1014 cp -fp "$src" "$dst"
1016 else
1017 # Leave any existing symlink alone, if it already points to the source,
1018 # so that broken build tools that care about symlink times
1019 # aren't confused into doing unnecessary builds. Conversely, if the
1020 # existing symlink's timestamp is older than the source, make it afresh,
1021 # so that broken tools aren't confused into skipping needed builds. See
1022 # <https://lists.gnu.org/r/bug-gnulib/2011-05/msg00326.html>.
1023 test -h "$dst" &&
1024 src_ls=$(ls -diL "$src" 2>/dev/null) && set $src_ls && src_i=$1 &&
1025 dst_ls=$(ls -diL "$dst" 2>/dev/null) && set $dst_ls && dst_i=$1 &&
1026 test "$src_i" = "$dst_i" &&
1027 both_ls=$(ls -dt "$src" "$dst") &&
1028 test "X$both_ls" = "X$dst$nl$src" || {
1029 dot_dots=
1030 case $src in
1031 /*) ;;
1033 case /$dst/ in
1034 *//* | */../* | */./* | /*/*/*/*/*/)
1035 die "invalid symlink calculation: $src -> $dst";;
1036 /*/*/*/*/) dot_dots=../../../;;
1037 /*/*/*/) dot_dots=../../;;
1038 /*/*/) dot_dots=../;;
1039 esac;;
1040 esac
1042 echo "$me: ln -fs $dot_dots$src $dst" &&
1043 ln -fs "$dot_dots$src" "$dst"
1049 # Regenerate all autogeneratable files that are omitted from the
1050 # version control repository. In particular, regenerate all
1051 # aclocal.m4, config.h.in, Makefile.in, configure files with new
1052 # versions of autoconf or automake.
1053 autogen()
1055 # Ensure that CDPATH is not set. Otherwise, the output from cd
1056 # would cause trouble in at least one use below.
1057 (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
1059 # Environment variables that may be set by the user.
1060 : "${AUTOPOINT=autopoint}"
1061 : "${AUTORECONF=autoreconf}"
1063 if test "$vc_ignore" = auto; then
1064 vc_ignore=
1065 test -d .git && vc_ignore=.gitignore
1066 test -d CVS && vc_ignore="$vc_ignore .cvsignore"
1070 # Parse options.
1072 # Whether to use copies instead of symlinks.
1073 copy=false
1075 for option
1077 case $option in
1078 --help)
1079 autogen_usage
1080 return;;
1081 --version)
1082 set -e
1083 echo "autogen.sh $scriptlibversion"
1084 echo "$copyright"
1085 return 0
1087 --force)
1088 checkout_only_file=;;
1089 --copy)
1090 copy=true;;
1092 bootstrap_option_hook $option || die "$option: unknown option";;
1093 esac
1094 done
1096 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
1097 || die "Error: \$GNULIB_SRCDIR environment variable or --gnulib-srcdir" \
1098 "option is specified, but does not denote a directory"
1100 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
1101 die "Running this script from a non-checked-out distribution is risky."
1104 if $use_gnulib; then
1105 if test -z "$GNULIB_SRCDIR"; then
1106 gnulib_path=$(test -f .gitmodules &&
1107 git config --file .gitmodules submodule.gnulib.path)
1108 test -z "$gnulib_path" && gnulib_path=gnulib
1109 GNULIB_SRCDIR=$gnulib_path
1113 # Die if there is no AC_CONFIG_AUX_DIR($build_aux) line in configure.ac.
1114 found_aux_dir=no
1115 grep '^[ ]*AC_CONFIG_AUX_DIR(\['"$build_aux"'])' configure.ac \
1116 >/dev/null && found_aux_dir=yes
1117 grep '^[ ]*AC_CONFIG_AUX_DIR('"$build_aux"')' configure.ac \
1118 >/dev/null && found_aux_dir=yes
1119 test $found_aux_dir = yes \
1120 || die "configure.ac lacks 'AC_CONFIG_AUX_DIR([$build_aux])'; add it"
1122 # If $build_aux doesn't exist, create it now, otherwise some bits
1123 # below will malfunction. If creating it, also mark it as ignored.
1124 if test ! -d $build_aux; then
1125 mkdir $build_aux
1126 for dot_ig in x $vc_ignore; do
1127 test $dot_ig = x && continue
1128 insert_vc_ignore $dot_ig $build_aux/
1129 done
1132 check_build_prerequisites false
1134 use_libtool=0
1135 # We'd like to use grep -E, to see if any of LT_INIT,
1136 # AC_PROG_LIBTOOL, AM_PROG_LIBTOOL is used in configure.ac,
1137 # but that's not portable enough (e.g., for Solaris).
1138 grep '^[ ]*A[CM]_PROG_LIBTOOL' configure.ac >/dev/null \
1139 && use_libtool=1
1140 grep '^[ ]*LT_INIT' configure.ac >/dev/null \
1141 && use_libtool=1
1142 if test $use_libtool = 1; then
1143 find_tool LIBTOOLIZE glibtoolize libtoolize
1146 if $use_gnulib; then
1147 gnulib_tool=$GNULIB_SRCDIR/gnulib-tool
1148 <$gnulib_tool || return
1151 # NOTE: we have to be careful to run both autopoint and libtoolize
1152 # before gnulib-tool, since gnulib-tool is likely to provide newer
1153 # versions of files "installed" by these two programs.
1154 # Then, *after* gnulib-tool (see below), we have to be careful to
1155 # run autoreconf in such a way that it does not run either of these
1156 # two just-pre-run programs.
1158 # Import from gettext.
1159 with_gettext=yes
1160 grep '^[ ]*AM_GNU_GETTEXT_VERSION(' configure.ac >/dev/null || \
1161 with_gettext=no
1163 if test $with_gettext = yes || test $use_libtool = 1; then
1165 tempbase=.bootstrap$$
1166 trap "rm -f $tempbase.0 $tempbase.1" HUP INT PIPE TERM
1168 > $tempbase.0 > $tempbase.1 &&
1169 find . ! -type d -print | sort > $tempbase.0 || return
1171 if test $with_gettext = yes; then
1172 # Released autopoint has the tendency to install macros that have been
1173 # obsoleted in current gnulib, so run this before gnulib-tool.
1174 echo "$0: $AUTOPOINT --force"
1175 $AUTOPOINT --force || return
1178 # Autoreconf runs aclocal before libtoolize, which causes spurious
1179 # warnings if the initial aclocal is confused by the libtoolized
1180 # (or worse out-of-date) macro directory.
1181 # libtoolize 1.9b added the --install option; but we support back
1182 # to libtoolize 1.5.22, where the install action was default.
1183 if test $use_libtool = 1; then
1184 install=
1185 case $($LIBTOOLIZE --help) in
1186 *--install*) install=--install ;;
1187 esac
1188 echo "running: $LIBTOOLIZE $install --copy"
1189 $LIBTOOLIZE $install --copy
1192 find . ! -type d -print | sort >$tempbase.1
1193 old_IFS=$IFS
1194 IFS=$nl
1195 for file in $(comm -13 $tempbase.0 $tempbase.1); do
1196 IFS=$old_IFS
1197 parent=${file%/*}
1198 version_controlled_file "$parent" "$file" || {
1199 for dot_ig in x $vc_ignore; do
1200 test $dot_ig = x && continue
1201 ig=$parent/$dot_ig
1202 insert_vc_ignore "$ig" "${file##*/}"
1203 done
1205 done
1206 IFS=$old_IFS
1208 rm -f $tempbase.0 $tempbase.1
1209 trap - HUP INT PIPE TERM
1212 # Import from gnulib.
1214 if $use_gnulib; then
1215 gnulib_tool_options="\
1216 --no-changelog\
1217 --aux-dir=$build_aux\
1218 --doc-base=$doc_base\
1219 --lib=$gnulib_name\
1220 --m4-base=$m4_base/\
1221 --source-base=$source_base/\
1222 --tests-base=$tests_base\
1223 --local-dir=$local_gl_dir\
1224 $gnulib_tool_option_extras\
1226 if test $use_libtool = 1; then
1227 case "$gnulib_tool_options " in
1228 *' --libtool '*) ;;
1229 *) gnulib_tool_options="$gnulib_tool_options --libtool" ;;
1230 esac
1232 echo "$0: $gnulib_tool $gnulib_tool_options --import ..."
1233 $gnulib_tool $gnulib_tool_options --import $gnulib_modules \
1234 || die "gnulib-tool failed"
1236 for file in $gnulib_files; do
1237 symlink_to_dir "$GNULIB_SRCDIR" $file \
1238 || die "failed to symlink $file"
1239 done
1242 bootstrap_post_import_hook \
1243 || die "bootstrap_post_import_hook failed"
1245 # Remove any dangling symlink matching "*.m4" or "*.[ch]" in some
1246 # gnulib-populated directories. Such .m4 files would cause aclocal to fail.
1247 # The following requires GNU find 4.2.3 or newer. Considering the usual
1248 # portability constraints of this script, that may seem a very demanding
1249 # requirement, but it should be ok. Ignore any failure, which is fine,
1250 # since this is only a convenience to help developers avoid the relatively
1251 # unusual case in which a symlinked-to .m4 file is git-removed from gnulib
1252 # between successive runs of this script.
1253 find "$m4_base" "$source_base" \
1254 -depth \( -name '*.m4' -o -name '*.[ch]' \) \
1255 -type l -xtype l -delete > /dev/null 2>&1
1257 # Invoke autoreconf with --force --install to ensure upgrades of tools
1258 # such as ylwrap.
1259 AUTORECONFFLAGS="--verbose --install --force -I $m4_base $ACLOCAL_FLAGS"
1260 AUTORECONFFLAGS="$AUTORECONFFLAGS --no-recursive"
1262 # Tell autoreconf not to invoke autopoint or libtoolize; they were run above.
1263 echo "running: AUTOPOINT=true LIBTOOLIZE=true $AUTORECONF $AUTORECONFFLAGS"
1264 AUTOPOINT=true LIBTOOLIZE=true $AUTORECONF $AUTORECONFFLAGS \
1265 || die "autoreconf failed"
1267 # Get some extra files from gnulib, overriding existing files.
1268 for file in $gnulib_extra_files; do
1269 case $file in
1270 */INSTALL) dst=INSTALL;;
1271 build-aux/*) dst=$build_aux/${file#build-aux/};;
1272 *) dst=$file;;
1273 esac
1274 symlink_to_dir "$GNULIB_SRCDIR" $file $dst \
1275 || die "failed to symlink $file"
1276 done
1278 if test $with_gettext = yes; then
1279 # Create gettext configuration.
1280 echo "$0: Creating po/Makevars from po/Makevars.template ..."
1281 rm -f po/Makevars
1282 sed '
1283 /^EXTRA_LOCALE_CATEGORIES *=/s/=.*/= '"$EXTRA_LOCALE_CATEGORIES"'/
1284 /^COPYRIGHT_HOLDER *=/s/=.*/= '"$COPYRIGHT_HOLDER"'/
1285 /^MSGID_BUGS_ADDRESS *=/s|=.*|= '"$MSGID_BUGS_ADDRESS"'|
1286 /^XGETTEXT_OPTIONS *=/{
1287 s/$/ \\/
1289 '"$XGETTEXT_OPTIONS"' $${end_of_xgettext_options+}
1291 ' po/Makevars.template >po/Makevars \
1292 || die 'cannot generate po/Makevars'
1294 # If the 'gettext' module is in use, grab the latest Makefile.in.in.
1295 # If only the 'gettext-h' module is in use, assume autopoint already
1296 # put the correct version of this file into place.
1297 case $gnulib_modules in
1298 *gettext-h*) ;;
1299 *gettext*)
1300 cp $GNULIB_SRCDIR/build-aux/po/Makefile.in.in po/Makefile.in.in \
1301 || die "cannot create po/Makefile.in.in"
1303 esac
1305 if test -d runtime-po; then
1306 # Similarly for runtime-po/Makevars, but not quite the same.
1307 rm -f runtime-po/Makevars
1308 sed '
1309 /^DOMAIN *=.*/s/=.*/= '"$package"'-runtime/
1310 /^subdir *=.*/s/=.*/= runtime-po/
1311 /^MSGID_BUGS_ADDRESS *=/s/=.*/= bug-'"$package"'@gnu.org/
1312 /^XGETTEXT_OPTIONS *=/{
1313 s/$/ \\/
1315 '"$XGETTEXT_OPTIONS_RUNTIME"' $${end_of_xgettext_options+}
1317 ' po/Makevars.template >runtime-po/Makevars \
1318 || die 'cannot generate runtime-po/Makevars'
1320 # Copy identical files from po to runtime-po.
1321 (cd po && cp -p Makefile.in.in *-quot *.header *.sed *.sin ../runtime-po)
1325 bootstrap_epilogue
1327 echo "$0: done. Now you can run './configure'."
1330 # ----------------------------------------------------------------------------
1332 # Local Variables:
1333 # eval: (add-hook 'before-save-hook 'time-stamp)
1334 # time-stamp-start: "scriptlibversion="
1335 # time-stamp-format: "%:y-%02m-%02d.%02H"
1336 # time-stamp-time-zone: "UTC0"
1337 # time-stamp-end: "; # UTC"
1338 # End:
1340 usage() {
1341 cat <<EOF
1342 Usage: $me [OPTION]...
1343 Bootstrap this package from the checked-out sources.
1345 Optional environment variables:
1346 GNULIB_SRCDIR Specifies the local directory where gnulib
1347 sources reside. Use this if you already
1348 have gnulib sources on your machine, and
1349 you want to use these sources.
1350 GNULIB_REFDIR Specifies the local directory where a gnulib
1351 repository (with a .git subdirectory) resides.
1352 Use this if you already have gnulib sources
1353 and history on your machine, and do not want
1354 to waste your bandwidth downloading them again.
1355 Only used for phase 1 (--pull).
1356 GNULIB_URL URL of the gnulib repository. The default is
1357 $default_gnulib_url,
1358 which is Gnulib's upstream repository.
1359 Only used for phase 1 (--pull).
1361 Options:
1363 --pull Do phase 1: Pull files from the network.
1364 --gen Do phase 2: Generate files from local files
1365 (no network access).
1366 (The default is to do both phases.)
1368 --gnulib-srcdir=DIRNAME Specifies the local directory where gnulib
1369 sources reside. Use this if you already
1370 have gnulib sources on your machine, and
1371 you want to use these sources. Defaults
1372 to \$GNULIB_SRCDIR.
1373 --gnulib-refdir=DIRNAME Specifies the local directory where a gnulib
1374 repository (with a .git subdirectory) resides.
1375 Use this if you already have gnulib sources
1376 and history on your machine, and do not want
1377 to waste your bandwidth downloading them again.
1378 Defaults to \$GNULIB_REFDIR.
1379 Only used for phase 1 (--pull).
1381 --bootstrap-sync If this bootstrap script is not identical to
1382 the version in the local gnulib sources,
1383 update this script, and then restart it with
1384 /bin/sh or the shell \$CONFIG_SHELL.
1385 --no-bootstrap-sync Do not check whether bootstrap is out of sync.
1387 --copy Copy files instead of creating symbolic links.
1388 Only used for phase 2 (--gen).
1389 --force Attempt to bootstrap even if the sources seem
1390 not to have been checked out.
1391 --no-git Do not use git to update gnulib. Requires that
1392 \$GNULIB_SRCDIR or the --gnulib-srcdir option
1393 points to a gnulib repository with the correct
1394 revision.
1395 Only used for phase 1 (--pull).
1396 --skip-po Do not download *.po files.
1397 Only used for phase 1 (--pull).
1399 bootstrap_print_option_usage_hook
1400 cat <<EOF
1401 If the file bootstrap.conf exists in the same directory as this script, its
1402 contents are read as shell variables to configure the bootstrap.
1404 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
1405 are honored.
1407 Gnulib sources can be fetched in various ways:
1409 * If GNULIB_SRCDIR is set (either as an environment variable or via the
1410 --gnulib-srcdir option), then sources are fetched from that local
1411 directory. If it is a git repository and the configuration variable
1412 GNULIB_REVISION is set in bootstrap.conf, then that revision is
1413 checked out.
1415 * Otherwise, if this package is in a git repository with a 'gnulib'
1416 submodule configured, then that submodule is initialized and updated
1417 and sources are fetched from there. If GNULIB_REFDIR is set (either
1418 as an environment variable or via the --gnulib-refdir option) and is
1419 a git repository, then it is used as a reference.
1421 * Otherwise, if the 'gnulib' directory does not exist, Gnulib sources
1422 are cloned into that directory using git from \$GNULIB_URL, defaulting
1423 to $default_gnulib_url.
1424 If the configuration variable GNULIB_REVISION is set in bootstrap.conf,
1425 then that revision is checked out.
1427 * Otherwise, the existing Gnulib sources in the 'gnulib' directory are
1428 used. If it is a git repository and the configuration variable
1429 GNULIB_REVISION is set in bootstrap.conf, then that revision is
1430 checked out.
1432 If you maintain a package and want to pin a particular revision of the
1433 Gnulib sources that has been tested with your package, then there are
1434 two possible approaches: either configure a 'gnulib' submodule with the
1435 appropriate revision, or set GNULIB_REVISION (and if necessary
1436 GNULIB_URL) in bootstrap.conf.
1438 Running without arguments will suffice in most cases.
1442 # Parse options.
1444 # Whether to pull and generate.
1445 pull=false
1446 gen=false
1448 # Whether to use copies instead of symlinks.
1449 copy=false
1451 # Use git to update gnulib sources
1452 use_git=true
1454 for option
1456 case $option in
1457 --help)
1458 usage
1459 exit;;
1460 --version)
1461 set -e
1462 echo "bootstrap $scriptversion lib $scriptlibversion"
1463 echo "$copyright"
1464 exit 0
1466 --pull)
1467 pull=true;;
1468 --gen)
1469 gen=true;;
1470 --gnulib-srcdir=*)
1471 GNULIB_SRCDIR=${option#--gnulib-srcdir=};;
1472 --gnulib-refdir=*)
1473 GNULIB_REFDIR=${option#--gnulib-refdir=};;
1474 --skip-po)
1475 SKIP_PO=t;;
1476 --force)
1477 checkout_only_file=;;
1478 --copy)
1479 copy=true;;
1480 --bootstrap-sync)
1481 bootstrap_sync=true;;
1482 --no-bootstrap-sync)
1483 bootstrap_sync=false;;
1484 --no-git)
1485 use_git=false;;
1487 bootstrap_option_hook $option || die "$option: unknown option";;
1488 esac
1489 done
1491 # Default is to do both.
1492 $pull || $gen || pull=true gen=true
1494 $use_git || test -n "$GNULIB_SRCDIR" \
1495 || die "Error: --no-git requires \$GNULIB_SRCDIR environment variable" \
1496 "or --gnulib-srcdir option"
1497 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
1498 || die "Error: \$GNULIB_SRCDIR environment variable or --gnulib-srcdir" \
1499 "option is specified, but does not denote a directory"
1501 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
1502 die "Bootstrapping from a non-checked-out distribution is risky."
1505 check_build_prerequisites $use_git
1507 if $bootstrap_sync; then
1508 prepare_GNULIB_SRCDIR
1509 upgrade_bootstrap "$@"
1510 # Since we have now upgraded if needed, no need to try it a second time below.
1511 bootstrap_sync=false
1514 echo "$0: Bootstrapping from checked-out $package sources..."
1516 # Pass GNULIB_SRCDIR and GNULIB_REFDIR to any subsidiary commands that care.
1517 export GNULIB_SRCDIR
1518 export GNULIB_REFDIR
1520 if $pull && { $use_git || test -z "$SKIP_PO"; }; then
1521 autopull \
1522 `if $bootstrap_sync; then
1523 echo ' --bootstrap-sync'
1524 else
1525 echo ' --no-bootstrap-sync'
1526 fi` \
1527 `if test -z "$checkout_only_file"; then echo ' --force'; fi` \
1528 `if ! $use_git; then echo ' --no-git'; fi` \
1529 `if test -n "$SKIP_PO"; then echo ' --skip-po'; fi` \
1530 || die "could not fetch auxiliary files"
1533 if $gen; then
1534 autogen \
1535 `if $copy; then echo ' --copy'; fi` \
1536 `if test -z "$checkout_only_file"; then echo ' --force'; fi` \
1537 || die "could not generate auxiliary files"
1540 # ----------------------------------------------------------------------------
1542 # Local Variables:
1543 # eval: (add-hook 'before-save-hook 'time-stamp)
1544 # time-stamp-start: "scriptversion="
1545 # time-stamp-format: "%:y-%02m-%02d.%02H"
1546 # time-stamp-time-zone: "UTC0"
1547 # time-stamp-end: "; # UTC"
1548 # End: