build: provide way to bootstrap with python gnulib-tool
[coreutils.git] / bootstrap
blob3173829dabf2265136fc5ec62f233aca52e83370
1 #! /bin/sh
2 # DO NOT EDIT! GENERATED AUTOMATICALLY!
4 # Bootstrap this package from checked-out sources.
6 scriptversion=2023-12-10.18; # 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=2023-12-10.18; # 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() {
482 status=$?
483 # XXX It's a bad idea to erase the submodule directory if it contains local
484 # modifications.
485 rm -fr "$gnulib_path"
486 exit $status
489 git_modules_config () {
490 test -f .gitmodules && git config --file .gitmodules "$@"
493 prepare_GNULIB_SRCDIR ()
495 if test -n "$GNULIB_SRCDIR"; then
496 # Use GNULIB_SRCDIR directly.
497 # We already checked that $GNULIB_SRCDIR references a directory.
498 # Verify that it contains a gnulib checkout.
499 test -f "$GNULIB_SRCDIR/gnulib-tool" \
500 || die "Error: --gnulib-srcdir or \$GNULIB_SRCDIR is specified," \
501 "but does not contain gnulib-tool"
502 elif $use_git; then
503 gnulib_path=$(git_modules_config submodule.gnulib.path)
504 test -z "$gnulib_path" && gnulib_path=gnulib
506 # Get gnulib files. Populate $gnulib_path, possibly updating a
507 # submodule, for use in the rest of the script.
509 if test -n "$GNULIB_REFDIR" && test -d "$GNULIB_REFDIR"/.git \
510 && git_modules_config submodule.gnulib.url >/dev/null; then
511 # Use GNULIB_REFDIR as a reference.
512 echo "$0: getting gnulib files..."
513 if git submodule -h|grep -- --reference > /dev/null; then
514 # Prefer the one-liner available in git 1.6.4 or newer.
515 git submodule update --init --reference "$GNULIB_REFDIR" \
516 "$gnulib_path" || exit $?
517 else
518 # This fallback allows at least git 1.5.5.
519 if test -f "$gnulib_path"/gnulib-tool; then
520 # Since file already exists, assume submodule init already complete.
521 git submodule update -- "$gnulib_path" || exit $?
522 else
523 # Older git can't clone into an empty directory.
524 rmdir "$gnulib_path" 2>/dev/null
525 git clone --reference "$GNULIB_REFDIR" \
526 "$(git_modules_config submodule.gnulib.url)" "$gnulib_path" \
527 && git submodule init -- "$gnulib_path" \
528 && git submodule update -- "$gnulib_path" \
529 || exit $?
532 else
533 # GNULIB_REFDIR is not set or not usable. Ignore it.
534 if git_modules_config submodule.gnulib.url >/dev/null; then
535 echo "$0: getting gnulib files..."
536 git submodule init -- "$gnulib_path" || exit $?
537 git submodule update -- "$gnulib_path" || exit $?
539 elif [ ! -d "$gnulib_path" ]; then
540 echo "$0: getting gnulib files..."
542 trap cleanup_gnulib HUP INT PIPE TERM
544 shallow=
545 if test -z "$GNULIB_REVISION"; then
546 if git clone -h 2>&1 | grep -- --depth > /dev/null; then
547 shallow='--depth 2'
549 git clone $shallow ${GNULIB_URL:-$default_gnulib_url} "$gnulib_path" \
550 || cleanup_gnulib
551 else
552 if git fetch -h 2>&1 | grep -- --depth > /dev/null; then
553 shallow='--depth 2'
555 mkdir -p "$gnulib_path"
556 # Only want a shallow checkout of $GNULIB_REVISION, but git does not
557 # support cloning by commit hash. So attempt a shallow fetch by commit
558 # hash to minimize the amount of data downloaded and changes needed to
559 # be processed, which can drastically reduce download and processing
560 # time for checkout. If the fetch by commit fails, a shallow fetch can
561 # not be performed because we do not know what the depth of the commit
562 # is without fetching all commits. So fall back to fetching all
563 # commits.
564 git -C "$gnulib_path" init
565 git -C "$gnulib_path" remote add origin \
566 ${GNULIB_URL:-$default_gnulib_url}
567 git -C "$gnulib_path" fetch $shallow origin "$GNULIB_REVISION" \
568 || git -C "$gnulib_path" fetch origin \
569 || cleanup_gnulib
570 git -C "$gnulib_path" reset --hard FETCH_HEAD
573 trap - HUP INT PIPE TERM
576 GNULIB_SRCDIR=$gnulib_path
577 # Verify that the submodule contains a gnulib checkout.
578 test -f "$gnulib_path/gnulib-tool" \
579 || die "Error: $gnulib_path is supposed to contain a gnulib checkout," \
580 "but does not contain gnulib-tool"
583 # XXX Should this be done if $use_git is false?
584 if test -d "$GNULIB_SRCDIR"/.git && test -n "$GNULIB_REVISION" \
585 && ! git_modules_config submodule.gnulib.url >/dev/null; then
586 (cd "$GNULIB_SRCDIR" && git checkout "$GNULIB_REVISION") || cleanup_gnulib
589 # $GNULIB_SRCDIR now points to the version of gnulib to use, and
590 # we no longer need to use git or $gnulib_path below here.
593 # -------- Upgrading bootstrap to the version found in GNULIB_SRCDIR. --------
595 upgrade_bootstrap ()
597 if test -f "$medir"/bootstrap-funclib.sh; then
598 update_lib=true
599 { cmp -s "$medir"/bootstrap "$GNULIB_SRCDIR/top/bootstrap" \
600 && cmp -s "$medir"/bootstrap-funclib.sh \
601 "$GNULIB_SRCDIR/top/bootstrap-funclib.sh" \
602 && cmp -s "$medir"/autopull.sh "$GNULIB_SRCDIR/top/autopull.sh" \
603 && cmp -s "$medir"/autogen.sh "$GNULIB_SRCDIR/top/autogen.sh"; \
605 else
606 update_lib=false
607 cmp -s "$medir"/bootstrap "$GNULIB_SRCDIR/build-aux/bootstrap"
608 fi || {
609 if $update_lib; then
610 echo "$0: updating bootstrap & companions and restarting..."
611 else
612 echo "$0: updating bootstrap and restarting..."
614 case $(sh -c 'echo "$1"' -- a) in
615 a) ignored=--;;
616 *) ignored=ignored;;
617 esac
618 u=$update_lib
619 exec sh -c \
620 '{ if '$u' && test -f "$1"; then cp "$1" "$3"; else cp "$2" "$3"; fi; } &&
621 { if '$u' && test -f "$4"; then cp "$4" "$5"; else rm -f "$5"; fi; } &&
622 { if '$u' && test -f "$6"; then cp "$6" "$7"; else rm -f "$7"; fi; } &&
623 { if '$u' && test -f "$8"; then cp "$8" "$9"; else rm -f "$9"; fi; } &&
624 shift && shift && shift && shift && shift &&
625 shift && shift && shift && shift &&
626 exec "${CONFIG_SHELL-/bin/sh}" "$@"' \
627 $ignored \
628 "$GNULIB_SRCDIR/top/bootstrap" "$GNULIB_SRCDIR/build-aux/bootstrap" \
629 "$medir/bootstrap" \
630 "$GNULIB_SRCDIR/top/bootstrap-funclib.sh" "$medir/bootstrap-funclib.sh" \
631 "$GNULIB_SRCDIR/top/autopull.sh" "$medir/autopull.sh" \
632 "$GNULIB_SRCDIR/top/autogen.sh" "$medir/autogen.sh" \
633 "$0" "$@" --no-bootstrap-sync
637 # ----------------------------------------------------------------------------
639 if test x"$gnulib_modules$gnulib_files$gnulib_extra_files" = x; then
640 use_gnulib=false
641 else
642 use_gnulib=true
645 # -------- Fetch auxiliary files from the network. --------------------------
647 autopull_usage() {
648 cat <<EOF
649 Usage: $me [OPTION]...
650 Bootstrap this package from the checked-out sources.
652 Optional environment variables:
653 GNULIB_SRCDIR Specifies the local directory where gnulib
654 sources reside. Use this if you already
655 have gnulib sources on your machine, and
656 you want to use these sources.
657 GNULIB_REFDIR Specifies the local directory where a gnulib
658 repository (with a .git subdirectory) resides.
659 Use this if you already have gnulib sources
660 and history on your machine, and do not want
661 to waste your bandwidth downloading them again.
662 GNULIB_URL URL of the gnulib repository. The default is
663 $default_gnulib_url,
664 which is Gnulib's upstream repository.
666 Options:
667 --bootstrap-sync if this bootstrap script is not identical to
668 the version in the local gnulib sources,
669 update this script, and then restart it with
670 /bin/sh or the shell \$CONFIG_SHELL
671 --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 or the --gnulib-srcdir option
676 points to a gnulib repository with the correct
677 revision
678 --skip-po do not download po files
680 bootstrap_print_option_usage_hook
681 cat <<EOF
682 If the file bootstrap.conf exists in the same directory as this script, its
683 contents are read as shell variables to configure the bootstrap.
685 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
686 are honored.
688 Gnulib sources can be fetched in various ways:
690 * If the environment variable GNULIB_SRCDIR is set (either as an
691 environment variable or via the --gnulib-srcdir option), then sources
692 are fetched from that local directory. If it is a git repository and
693 the configuration variable GNULIB_REVISION is set in bootstrap.conf,
694 then that revision is checked out.
696 * Otherwise, if this package is in a git repository with a 'gnulib'
697 submodule configured, then that submodule is initialized and updated
698 and sources are fetched from there. If GNULIB_REFDIR is set (either
699 as an environment variable or via the --gnulib-refdir option) and is
700 a git repository, then it is used as a reference.
702 * Otherwise, if the 'gnulib' directory does not exist, Gnulib sources
703 are cloned into that directory using git from \$GNULIB_URL, defaulting
704 to $default_gnulib_url.
705 If the configuration variable GNULIB_REVISION is set in bootstrap.conf,
706 then that revision is checked out.
708 * Otherwise, the existing Gnulib sources in the 'gnulib' directory are
709 used. If it is a git repository and the configuration variable
710 GNULIB_REVISION is set in bootstrap.conf, then that revision is
711 checked out.
713 If you maintain a package and want to pin a particular revision of the
714 Gnulib sources that has been tested with your package, then there are
715 two possible approaches: either configure a 'gnulib' submodule with the
716 appropriate revision, or set GNULIB_REVISION (and if necessary
717 GNULIB_URL) in bootstrap.conf.
719 Running without arguments will suffice in most cases.
723 # Fetch auxiliary files that are omitted from the version control
724 # repository of this package.
725 autopull()
727 # Ensure that CDPATH is not set. Otherwise, the output from cd
728 # would cause trouble in at least one use below.
729 (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
731 # Parse options.
733 # Use git to update gnulib sources
734 use_git=true
736 for option
738 case $option in
739 --help)
740 autopull_usage
741 return;;
742 --version)
743 set -e
744 echo "autopull.sh $scriptlibversion"
745 echo "$copyright"
746 return 0
748 --skip-po)
749 SKIP_PO=t;;
750 --force)
751 checkout_only_file=;;
752 --bootstrap-sync)
753 bootstrap_sync=true;;
754 --no-bootstrap-sync)
755 bootstrap_sync=false;;
756 --no-git)
757 use_git=false;;
759 bootstrap_option_hook $option || die "$option: unknown option";;
760 esac
761 done
763 $use_git || test -n "$GNULIB_SRCDIR" \
764 || die "Error: --no-git requires \$GNULIB_SRCDIR environment variable" \
765 "or --gnulib-srcdir option"
766 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
767 || die "Error: \$GNULIB_SRCDIR environment variable" \
768 "or --gnulib-srcdir option is specified," \
769 "but does not denote a directory"
771 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
772 die "Running this script from a non-checked-out distribution is risky."
775 check_build_prerequisites $use_git
777 if $use_gnulib || $bootstrap_sync; then
778 prepare_GNULIB_SRCDIR
779 if $bootstrap_sync; then
780 upgrade_bootstrap "$@"
784 # Find sha1sum, named gsha1sum on MacPorts, shasum on Mac OS X 10.6.
785 # Also find the compatible sha1 utility on the BSDs
786 if test x"$SKIP_PO" = x; then
787 find_tool SHA1SUM sha1sum gsha1sum shasum sha1
790 # See if we can use gnulib's git-merge-changelog merge driver.
791 if $use_git && test -d .git && check_exists git; then
792 if git config merge.merge-changelog.driver >/dev/null ; then
794 elif check_exists git-merge-changelog; then
795 echo "$0: initializing git-merge-changelog driver"
796 git config merge.merge-changelog.name 'GNU-style ChangeLog merge driver'
797 git config merge.merge-changelog.driver 'git-merge-changelog %O %A %B'
798 else
799 echo "$0: consider installing git-merge-changelog from gnulib"
803 case $SKIP_PO in
805 if test -d po; then
806 update_po_files po $package || return
809 if test -d runtime-po; then
810 update_po_files runtime-po $package-runtime || return
811 fi;;
812 esac
814 # ---------------------------------------------------------------------------
816 bootstrap_post_pull_hook \
817 || die "bootstrap_post_pull_hook failed"
819 # Don't proceed if there are uninitialized submodules. In particular,
820 # autogen.sh will remove dangling links, which might be links into
821 # uninitialized submodules.
822 # But it's OK if the 'gnulib' submodule is uninitialized, as long as
823 # GNULIB_SRCDIR is set.
824 if $use_git; then
825 # Uninitialized submodules are listed with an initial dash.
826 uninitialized=`git submodule | grep '^-' | awk '{ print $2 }'`
827 if test -n "$GNULIB_SRCDIR"; then
828 uninitialized=`echo "$uninitialized" | grep -v '^gnulib$'`
830 if test -n "$uninitialized"; then
831 uninit_comma=`echo "$uninitialized" | tr '\n' ',' | sed -e 's|,$|.|'`
832 die "Some git submodules are not initialized: "$uninit_comma \
833 "Either use option '--no-git'," \
834 "or run 'git submodule update --init' and bootstrap again."
838 if test -f "$medir"/autogen.sh; then
839 echo "$0: done. Now you can run '$medir/autogen.sh'."
843 # ----------------------------- Get translations. -----------------------------
845 download_po_files() {
846 subdir=$1
847 domain=$2
848 echo "$me: getting translations into $subdir for $domain..."
849 cmd=$(printf "$po_download_command_format" "$subdir" "$domain")
850 eval "$cmd"
853 # Mirror .po files to $po_dir/.reference and copy only the new
854 # or modified ones into $po_dir. Also update $po_dir/LINGUAS.
855 # Note po files that exist locally only are left in $po_dir but will
856 # not be included in LINGUAS and hence will not be distributed.
857 update_po_files() {
858 # Directory containing primary .po files.
859 # Overwrite them only when we're sure a .po file is new.
860 po_dir=$1
861 domain=$2
863 # Mirror *.po files into this dir.
864 # Usually contains *.s1 checksum files.
865 ref_po_dir="$po_dir/.reference"
867 test -d $ref_po_dir || mkdir $ref_po_dir || return
868 download_po_files $ref_po_dir $domain \
869 && ls "$ref_po_dir"/*.po 2>/dev/null |
870 sed 's|.*/||; s|\.po$||' > "$po_dir/LINGUAS" || return
872 langs=$(cd $ref_po_dir && echo *.po | sed 's/\.po//g')
873 test "$langs" = '*' && langs=x
874 for po in $langs; do
875 case $po in x) continue;; esac
876 new_po="$ref_po_dir/$po.po"
877 cksum_file="$ref_po_dir/$po.s1"
878 if ! test -f "$cksum_file" ||
879 ! test -f "$po_dir/$po.po" ||
880 ! $SHA1SUM -c "$cksum_file" < "$new_po" > /dev/null 2>&1; then
881 echo "$me: updated $po_dir/$po.po..."
882 cp "$new_po" "$po_dir/$po.po" \
883 && $SHA1SUM < "$new_po" > "$cksum_file" || return
885 done
888 # -------- Generate files automatically from existing sources. --------------
890 autogen_usage() {
891 cat <<EOF
892 Usage: $me [OPTION]...
893 Bootstrap this package from the checked-out sources.
895 Optional environment variables:
896 GNULIB_SRCDIR Specifies the local directory where gnulib
897 sources reside. Use this if you already
898 have gnulib sources on your machine, and
899 you want to use these sources.
901 Options:
902 --copy copy files instead of creating symbolic links
903 --force attempt to bootstrap even if the sources seem
904 not to have been checked out
906 bootstrap_print_option_usage_hook
907 cat <<EOF
908 If the file bootstrap.conf exists in the same directory as this script, its
909 contents are read as shell variables to configure the bootstrap.
911 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
912 are honored.
914 Gnulib sources are assumed to be present:
915 * in \$GNULIB_SRCDIR, if that environment variable is set,
916 * otherwise, in the 'gnulib' submodule, if such a submodule is configured,
917 * otherwise, in the 'gnulib' subdirectory.
919 Running without arguments will suffice in most cases.
924 version_controlled_file() {
925 parent=$1
926 file=$2
927 if test -d .git; then
928 git rm -n "$file" > /dev/null 2>&1
929 elif test -d .svn; then
930 svn log -r HEAD "$file" > /dev/null 2>&1
931 elif test -d CVS; then
932 grep -F "/${file##*/}/" "$parent/CVS/Entries" 2>/dev/null |
933 grep '^/[^/]*/[0-9]' > /dev/null
934 else
935 warn_ "no version control for $file?"
936 false
940 # Strip blank and comment lines to leave significant entries.
941 gitignore_entries() {
942 sed '/^#/d; /^$/d' "$@"
945 # If $STR is not already on a line by itself in $FILE, insert it at the start.
946 # Entries are inserted at the start of the ignore list to ensure existing
947 # entries starting with ! are not overridden. Such entries support
948 # whitelisting exceptions after a more generic blacklist pattern.
949 insert_if_absent() {
950 file=$1
951 str=$2
952 test -f $file || touch $file
953 test -r $file || die "Error: failed to read ignore file: $file"
954 duplicate_entries=$(gitignore_entries $file | sort | uniq -d)
955 if [ "$duplicate_entries" ] ; then
956 die "Error: Duplicate entries in $file: " $duplicate_entries
958 linesold=$(gitignore_entries $file | wc -l)
959 linesnew=$( { echo "$str"; cat $file; } | gitignore_entries | sort -u | wc -l)
960 if [ $linesold != $linesnew ] ; then
961 { echo "$str" | cat - $file > $file.bak && mv $file.bak $file; } \
962 || die "insert_if_absent $file $str: failed"
966 # Adjust $PATTERN for $VC_IGNORE_FILE and insert it with
967 # insert_if_absent.
968 insert_vc_ignore() {
969 vc_ignore_file="$1"
970 pattern="$2"
971 case $vc_ignore_file in
972 *.gitignore)
973 # A .gitignore entry that does not start with '/' applies
974 # recursively to subdirectories, so prepend '/' to every
975 # .gitignore entry.
976 pattern=$(echo "$pattern" | sed s,^,/,);;
977 esac
978 insert_if_absent "$vc_ignore_file" "$pattern"
981 symlink_to_dir()
983 src=$1/$2
984 dst=${3-$2}
986 test -f "$src" && {
988 # If the destination directory doesn't exist, create it.
989 # This is required at least for "lib/uniwidth/cjk.h".
990 dst_dir=$(dirname "$dst")
991 if ! test -d "$dst_dir"; then
992 mkdir -p "$dst_dir"
994 # If we've just created a directory like lib/uniwidth,
995 # tell version control system(s) it's ignorable.
996 # FIXME: for now, this does only one level
997 parent=$(dirname "$dst_dir")
998 for dot_ig in x $vc_ignore; do
999 test $dot_ig = x && continue
1000 ig=$parent/$dot_ig
1001 insert_vc_ignore $ig "${dst_dir##*/}/"
1002 done
1005 if $copy; then
1007 test ! -h "$dst" || {
1008 echo "$me: rm -f $dst" &&
1009 rm -f "$dst"
1011 } &&
1012 test -f "$dst" &&
1013 cmp -s "$src" "$dst" || {
1014 echo "$me: cp -fp $src $dst" &&
1015 cp -fp "$src" "$dst"
1017 else
1018 # Leave any existing symlink alone, if it already points to the source,
1019 # so that broken build tools that care about symlink times
1020 # aren't confused into doing unnecessary builds. Conversely, if the
1021 # existing symlink's timestamp is older than the source, make it afresh,
1022 # so that broken tools aren't confused into skipping needed builds. See
1023 # <https://lists.gnu.org/r/bug-gnulib/2011-05/msg00326.html>.
1024 test -h "$dst" &&
1025 src_ls=$(ls -diL "$src" 2>/dev/null) && set $src_ls && src_i=$1 &&
1026 dst_ls=$(ls -diL "$dst" 2>/dev/null) && set $dst_ls && dst_i=$1 &&
1027 test "$src_i" = "$dst_i" &&
1028 both_ls=$(ls -dt "$src" "$dst") &&
1029 test "X$both_ls" = "X$dst$nl$src" || {
1030 dot_dots=
1031 case $src in
1032 /*) ;;
1034 case /$dst/ in
1035 *//* | */../* | */./* | /*/*/*/*/*/)
1036 die "invalid symlink calculation: $src -> $dst";;
1037 /*/*/*/*/) dot_dots=../../../;;
1038 /*/*/*/) dot_dots=../../;;
1039 /*/*/) dot_dots=../;;
1040 esac;;
1041 esac
1043 echo "$me: ln -fs $dot_dots$src $dst" &&
1044 ln -fs "$dot_dots$src" "$dst"
1050 # Regenerate all autogeneratable files that are omitted from the
1051 # version control repository. In particular, regenerate all
1052 # aclocal.m4, config.h.in, Makefile.in, configure files with new
1053 # versions of autoconf or automake.
1054 autogen()
1056 # Ensure that CDPATH is not set. Otherwise, the output from cd
1057 # would cause trouble in at least one use below.
1058 (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
1060 # Environment variables that may be set by the user.
1061 : "${AUTOPOINT=autopoint}"
1062 : "${AUTORECONF=autoreconf}"
1064 if test "$vc_ignore" = auto; then
1065 vc_ignore=
1066 test -d .git && vc_ignore=.gitignore
1067 test -d CVS && vc_ignore="$vc_ignore .cvsignore"
1071 # Parse options.
1073 # Whether to use copies instead of symlinks.
1074 copy=false
1076 for option
1078 case $option in
1079 --help)
1080 autogen_usage
1081 return;;
1082 --version)
1083 set -e
1084 echo "autogen.sh $scriptlibversion"
1085 echo "$copyright"
1086 return 0
1088 --force)
1089 checkout_only_file=;;
1090 --copy)
1091 copy=true;;
1093 bootstrap_option_hook $option || die "$option: unknown option";;
1094 esac
1095 done
1097 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
1098 || die "Error: \$GNULIB_SRCDIR environment variable or --gnulib-srcdir" \
1099 "option is specified, but does not denote a directory"
1101 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
1102 die "Running this script from a non-checked-out distribution is risky."
1105 if $use_gnulib; then
1106 if test -z "$GNULIB_SRCDIR"; then
1107 gnulib_path=$(test -f .gitmodules &&
1108 git config --file .gitmodules submodule.gnulib.path)
1109 test -z "$gnulib_path" && gnulib_path=gnulib
1110 GNULIB_SRCDIR=$gnulib_path
1114 # Die if there is no AC_CONFIG_AUX_DIR($build_aux) line in configure.ac.
1115 found_aux_dir=no
1116 grep '^[ ]*AC_CONFIG_AUX_DIR(\['"$build_aux"'])' configure.ac \
1117 >/dev/null && found_aux_dir=yes
1118 grep '^[ ]*AC_CONFIG_AUX_DIR('"$build_aux"')' configure.ac \
1119 >/dev/null && found_aux_dir=yes
1120 test $found_aux_dir = yes \
1121 || die "configure.ac lacks 'AC_CONFIG_AUX_DIR([$build_aux])'; add it"
1123 # If $build_aux doesn't exist, create it now, otherwise some bits
1124 # below will malfunction. If creating it, also mark it as ignored.
1125 if test ! -d $build_aux; then
1126 mkdir $build_aux
1127 for dot_ig in x $vc_ignore; do
1128 test $dot_ig = x && continue
1129 insert_vc_ignore $dot_ig $build_aux/
1130 done
1133 check_build_prerequisites false
1135 use_libtool=0
1136 # We'd like to use grep -E, to see if any of LT_INIT,
1137 # AC_PROG_LIBTOOL, AM_PROG_LIBTOOL is used in configure.ac,
1138 # but that's not portable enough (e.g., for Solaris).
1139 grep '^[ ]*A[CM]_PROG_LIBTOOL' configure.ac >/dev/null \
1140 && use_libtool=1
1141 grep '^[ ]*LT_INIT' configure.ac >/dev/null \
1142 && use_libtool=1
1143 if test $use_libtool = 1; then
1144 find_tool LIBTOOLIZE glibtoolize libtoolize
1147 if $use_gnulib; then
1148 gnulib_tool=$GNULIB_SRCDIR/gnulib-tool
1149 <$gnulib_tool || return
1152 # NOTE: we have to be careful to run both autopoint and libtoolize
1153 # before gnulib-tool, since gnulib-tool is likely to provide newer
1154 # versions of files "installed" by these two programs.
1155 # Then, *after* gnulib-tool (see below), we have to be careful to
1156 # run autoreconf in such a way that it does not run either of these
1157 # two just-pre-run programs.
1159 # Import from gettext.
1160 with_gettext=yes
1161 grep '^[ ]*AM_GNU_GETTEXT_VERSION(' configure.ac >/dev/null || \
1162 with_gettext=no
1164 if test $with_gettext = yes || test $use_libtool = 1; then
1166 tempbase=.bootstrap$$
1167 trap "rm -f $tempbase.0 $tempbase.1" HUP INT PIPE TERM
1169 > $tempbase.0 > $tempbase.1 &&
1170 find . ! -type d -print | sort > $tempbase.0 || return
1172 if test $with_gettext = yes; then
1173 # Released autopoint has the tendency to install macros that have been
1174 # obsoleted in current gnulib, so run this before gnulib-tool.
1175 echo "$0: $AUTOPOINT --force"
1176 $AUTOPOINT --force || return
1179 # Autoreconf runs aclocal before libtoolize, which causes spurious
1180 # warnings if the initial aclocal is confused by the libtoolized
1181 # (or worse out-of-date) macro directory.
1182 # libtoolize 1.9b added the --install option; but we support back
1183 # to libtoolize 1.5.22, where the install action was default.
1184 if test $use_libtool = 1; then
1185 install=
1186 case $($LIBTOOLIZE --help) in
1187 *--install*) install=--install ;;
1188 esac
1189 echo "running: $LIBTOOLIZE $install --copy"
1190 $LIBTOOLIZE $install --copy
1193 find . ! -type d -print | sort >$tempbase.1
1194 old_IFS=$IFS
1195 IFS=$nl
1196 for file in $(comm -13 $tempbase.0 $tempbase.1); do
1197 IFS=$old_IFS
1198 parent=${file%/*}
1199 version_controlled_file "$parent" "$file" || {
1200 for dot_ig in x $vc_ignore; do
1201 test $dot_ig = x && continue
1202 ig=$parent/$dot_ig
1203 insert_vc_ignore "$ig" "${file##*/}"
1204 done
1206 done
1207 IFS=$old_IFS
1209 rm -f $tempbase.0 $tempbase.1
1210 trap - HUP INT PIPE TERM
1213 # Import from gnulib.
1215 if $use_gnulib; then
1216 gnulib_tool_options="\
1217 --no-changelog\
1218 --aux-dir=$build_aux\
1219 --doc-base=$doc_base\
1220 --lib=$gnulib_name\
1221 --m4-base=$m4_base/\
1222 --source-base=$source_base/\
1223 --tests-base=$tests_base\
1224 --local-dir=$local_gl_dir\
1225 $gnulib_tool_option_extras\
1227 if test $use_libtool = 1; then
1228 case "$gnulib_tool_options " in
1229 *' --libtool '*) ;;
1230 *) gnulib_tool_options="$gnulib_tool_options --libtool" ;;
1231 esac
1233 echo "$0: $gnulib_tool $gnulib_tool_options --import ..."
1234 $gnulib_tool $gnulib_tool_options --import $gnulib_modules \
1235 || die "gnulib-tool failed"
1237 for file in $gnulib_files; do
1238 symlink_to_dir "$GNULIB_SRCDIR" $file \
1239 || die "failed to symlink $file"
1240 done
1243 bootstrap_post_import_hook \
1244 || die "bootstrap_post_import_hook failed"
1246 # Remove any dangling symlink matching "*.m4" or "*.[ch]" in some
1247 # gnulib-populated directories. Such .m4 files would cause aclocal to fail.
1248 # The following requires GNU find 4.2.3 or newer. Considering the usual
1249 # portability constraints of this script, that may seem a very demanding
1250 # requirement, but it should be ok. Ignore any failure, which is fine,
1251 # since this is only a convenience to help developers avoid the relatively
1252 # unusual case in which a symlinked-to .m4 file is git-removed from gnulib
1253 # between successive runs of this script.
1254 find "$m4_base" "$source_base" \
1255 -depth \( -name '*.m4' -o -name '*.[ch]' \) \
1256 -type l -xtype l -delete > /dev/null 2>&1
1258 # Invoke autoreconf with --force --install to ensure upgrades of tools
1259 # such as ylwrap.
1260 AUTORECONFFLAGS="--verbose --install --force -I $m4_base $ACLOCAL_FLAGS"
1261 AUTORECONFFLAGS="$AUTORECONFFLAGS --no-recursive"
1263 # Tell autoreconf not to invoke autopoint or libtoolize; they were run above.
1264 echo "running: AUTOPOINT=true LIBTOOLIZE=true $AUTORECONF $AUTORECONFFLAGS"
1265 AUTOPOINT=true LIBTOOLIZE=true $AUTORECONF $AUTORECONFFLAGS \
1266 || die "autoreconf failed"
1268 # Get some extra files from gnulib, overriding existing files.
1269 for file in $gnulib_extra_files; do
1270 case $file in
1271 */INSTALL) dst=INSTALL;;
1272 build-aux/*) dst=$build_aux/${file#build-aux/};;
1273 *) dst=$file;;
1274 esac
1275 symlink_to_dir "$GNULIB_SRCDIR" $file $dst \
1276 || die "failed to symlink $file"
1277 done
1279 if test $with_gettext = yes; then
1280 # Create gettext configuration.
1281 echo "$0: Creating po/Makevars from po/Makevars.template ..."
1282 rm -f po/Makevars
1283 sed '
1284 /^EXTRA_LOCALE_CATEGORIES *=/s/=.*/= '"$EXTRA_LOCALE_CATEGORIES"'/
1285 /^COPYRIGHT_HOLDER *=/s/=.*/= '"$COPYRIGHT_HOLDER"'/
1286 /^MSGID_BUGS_ADDRESS *=/s|=.*|= '"$MSGID_BUGS_ADDRESS"'|
1287 /^XGETTEXT_OPTIONS *=/{
1288 s/$/ \\/
1290 '"$XGETTEXT_OPTIONS"' $${end_of_xgettext_options+}
1292 ' po/Makevars.template >po/Makevars \
1293 || die 'cannot generate po/Makevars'
1295 # If the 'gettext' module is in use, grab the latest Makefile.in.in.
1296 # If only the 'gettext-h' module is in use, assume autopoint already
1297 # put the correct version of this file into place.
1298 case $gnulib_modules in
1299 *gettext-h*) ;;
1300 *gettext*)
1301 cp $GNULIB_SRCDIR/build-aux/po/Makefile.in.in po/Makefile.in.in \
1302 || die "cannot create po/Makefile.in.in"
1304 esac
1306 if test -d runtime-po; then
1307 # Similarly for runtime-po/Makevars, but not quite the same.
1308 rm -f runtime-po/Makevars
1309 sed '
1310 /^DOMAIN *=.*/s/=.*/= '"$package"'-runtime/
1311 /^subdir *=.*/s/=.*/= runtime-po/
1312 /^MSGID_BUGS_ADDRESS *=/s/=.*/= bug-'"$package"'@gnu.org/
1313 /^XGETTEXT_OPTIONS *=/{
1314 s/$/ \\/
1316 '"$XGETTEXT_OPTIONS_RUNTIME"' $${end_of_xgettext_options+}
1318 ' po/Makevars.template >runtime-po/Makevars \
1319 || die 'cannot generate runtime-po/Makevars'
1321 # Copy identical files from po to runtime-po.
1322 (cd po && cp -p Makefile.in.in *-quot *.header *.sed *.sin ../runtime-po)
1326 bootstrap_epilogue
1328 echo "$0: done. Now you can run './configure'."
1331 # ----------------------------------------------------------------------------
1333 # Local Variables:
1334 # eval: (add-hook 'before-save-hook 'time-stamp)
1335 # time-stamp-start: "scriptlibversion="
1336 # time-stamp-format: "%:y-%02m-%02d.%02H"
1337 # time-stamp-time-zone: "UTC0"
1338 # time-stamp-end: "; # UTC"
1339 # End:
1341 usage() {
1342 cat <<EOF
1343 Usage: $me [OPTION]...
1344 Bootstrap this package from the checked-out sources.
1346 Optional environment variables:
1347 GNULIB_SRCDIR Specifies the local directory where gnulib
1348 sources reside. Use this if you already
1349 have gnulib sources on your machine, and
1350 do not want to waste your bandwidth downloading
1351 them again.
1352 GNULIB_URL URL of the gnulib repository. The default is
1353 $default_gnulib_url,
1354 which is Gnulib's upstream repository.
1356 Options:
1358 --pull Do phase 1: pull files from network
1359 --gen Do phase 2: generate from local files.
1360 (The default is to do both phases.)
1362 --gnulib-srcdir=DIRNAME specify the local directory where gnulib
1363 sources reside. Use this if you already
1364 have gnulib sources on your machine, and
1365 you want to use these sources. Defaults
1366 to \$GNULIB_SRCDIR
1367 --gnulib-refdir=DIRNAME specify the local directory where a gnulib
1368 repository (with a .git subdirectory) resides.
1369 Use this if you already have gnulib sources
1370 and history on your machine, and do not want
1371 to waste your bandwidth downloading them again.
1372 Defaults to \$GNULIB_REFDIR
1374 --bootstrap-sync if this bootstrap script is not identical to
1375 the version in the local gnulib sources,
1376 update this script, and then restart it with
1377 /bin/sh or the shell \$CONFIG_SHELL
1378 --no-bootstrap-sync do not check whether bootstrap is out of sync
1380 --copy copy files instead of creating symbolic links
1381 --force attempt to bootstrap even if the sources seem
1382 not to have been checked out
1383 --no-git do not use git to update gnulib. Requires that
1384 \$GNULIB_SRCDIR or the --gnulib-srcdir option
1385 points to a gnulib repository with the correct
1386 revision
1387 --skip-po do not download po files
1389 bootstrap_print_option_usage_hook
1390 cat <<EOF
1391 If the file bootstrap.conf exists in the same directory as this script, its
1392 contents are read as shell variables to configure the bootstrap.
1394 For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR
1395 are honored.
1397 Gnulib sources can be fetched in various ways:
1399 * If the environment variable GNULIB_SRCDIR is set (either as an
1400 environment variable or via the --gnulib-srcdir option), then sources
1401 are fetched from that local directory. If it is a git repository and
1402 the configuration variable GNULIB_REVISION is set in bootstrap.conf,
1403 then that revision is checked out.
1405 * Otherwise, if this package is in a git repository with a 'gnulib'
1406 submodule configured, then that submodule is initialized and updated
1407 and sources are fetched from there. If GNULIB_REFDIR is set (either
1408 as an environment variable or via the --gnulib-refdir option) and is
1409 a git repository, then it is used as a reference.
1411 * Otherwise, if the 'gnulib' directory does not exist, Gnulib sources
1412 are cloned into that directory using git from \$GNULIB_URL, defaulting
1413 to $default_gnulib_url.
1414 If the configuration variable GNULIB_REVISION is set in bootstrap.conf,
1415 then that revision is checked out.
1417 * Otherwise, the existing Gnulib sources in the 'gnulib' directory are
1418 used. If it is a git repository and the configuration variable
1419 GNULIB_REVISION is set in bootstrap.conf, then that revision is
1420 checked out.
1422 If you maintain a package and want to pin a particular revision of the
1423 Gnulib sources that has been tested with your package, then there are
1424 two possible approaches: either configure a 'gnulib' submodule with the
1425 appropriate revision, or set GNULIB_REVISION (and if necessary
1426 GNULIB_URL) in bootstrap.conf.
1428 Running without arguments will suffice in most cases.
1432 # Parse options.
1434 # Whether to pull and generate.
1435 pull=false
1436 gen=false
1438 # Whether to use copies instead of symlinks.
1439 copy=false
1441 # Use git to update gnulib sources
1442 use_git=true
1444 for option
1446 case $option in
1447 --help)
1448 usage
1449 exit;;
1450 --version)
1451 set -e
1452 echo "bootstrap $scriptversion lib $scriptlibversion"
1453 echo "$copyright"
1454 exit 0
1456 --pull)
1457 pull=true;;
1458 --gen)
1459 gen=true;;
1460 --gnulib-srcdir=*)
1461 GNULIB_SRCDIR=${option#--gnulib-srcdir=};;
1462 --gnulib-refdir=*)
1463 GNULIB_REFDIR=${option#--gnulib-refdir=};;
1464 --skip-po)
1465 SKIP_PO=t;;
1466 --force)
1467 checkout_only_file=;;
1468 --copy)
1469 copy=true;;
1470 --bootstrap-sync)
1471 bootstrap_sync=true;;
1472 --no-bootstrap-sync)
1473 bootstrap_sync=false;;
1474 --no-git)
1475 use_git=false;;
1477 bootstrap_option_hook $option || die "$option: unknown option";;
1478 esac
1479 done
1481 # Default is to do both.
1482 $pull || $gen || pull=true gen=true
1484 $use_git || test -n "$GNULIB_SRCDIR" \
1485 || die "Error: --no-git requires \$GNULIB_SRCDIR environment variable" \
1486 "or --gnulib-srcdir option"
1487 test -z "$GNULIB_SRCDIR" || test -d "$GNULIB_SRCDIR" \
1488 || die "Error: \$GNULIB_SRCDIR environment variable or --gnulib-srcdir" \
1489 "option is specified, but does not denote a directory"
1491 if test -n "$checkout_only_file" && test ! -r "$checkout_only_file"; then
1492 die "Bootstrapping from a non-checked-out distribution is risky."
1495 check_build_prerequisites $use_git
1497 if $bootstrap_sync; then
1498 prepare_GNULIB_SRCDIR
1499 upgrade_bootstrap "$@"
1500 # Since we have now upgraded if needed, no need to try it a second time below.
1501 bootstrap_sync=false
1504 echo "$0: Bootstrapping from checked-out $package sources..."
1506 # Pass GNULIB_SRCDIR and GNULIB_REFDIR to any subsidiary commands that care.
1507 export GNULIB_SRCDIR
1508 export GNULIB_REFDIR
1510 if $pull && { $use_git || test -z "$SKIP_PO"; }; then
1511 autopull \
1512 `if $bootstrap_sync; then
1513 echo ' --bootstrap-sync'
1514 else
1515 echo ' --no-bootstrap-sync'
1516 fi` \
1517 `if test -z "$checkout_only_file"; then echo ' --force'; fi` \
1518 `if ! $use_git; then echo ' --no-git'; fi` \
1519 `if test -n "$SKIP_PO"; then echo ' --skip-po'; fi` \
1520 || die "could not fetch auxiliary files"
1523 if $gen; then
1524 autogen \
1525 `if $copy; then echo ' --copy'; fi` \
1526 `if test -z "$checkout_only_file"; then echo ' --force'; fi` \
1527 || die "could not generate auxiliary files"
1530 # ----------------------------------------------------------------------------
1532 # Local Variables:
1533 # eval: (add-hook 'before-save-hook 'time-stamp)
1534 # time-stamp-start: "scriptversion="
1535 # time-stamp-format: "%:y-%02m-%02d.%02H"
1536 # time-stamp-time-zone: "UTC0"
1537 # time-stamp-end: "; # UTC"
1538 # End: