Mercurial > gnulib
changeset 39403:c477f146c0ac
bootstrap: document source fetching in --help
There are many possibilities for how Gnulib sources are fetched, and
they're rather hard to figure out without reading the code.
* build-aux/bootstrap (usage): Document how Gnulib sources are fetched.
| author | Colin Watson <cjwatson@debian.org> |
|---|---|
| date | Sun, 27 May 2018 22:13:41 +0200 |
| parents | 15f418111755 |
| children | 6a86d4bde4e3 |
| files | ChangeLog build-aux/bootstrap |
| diffstat | 2 files changed, 40 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Sun May 27 22:07:58 2018 +0200 +++ b/ChangeLog Sun May 27 22:13:41 2018 +0200 @@ -1,3 +1,8 @@ +2018-05-27 Colin Watson <cjwatson@debian.org> + + bootstrap: document source fetching in --help + * build-aux/bootstrap (usage): Document how Gnulib sources are fetched. + 2018-04-09 Colin Watson <cjwatson@debian.org> bootstrap: allow non-submodule control of gnulib
--- a/build-aux/bootstrap Sun May 27 22:07:58 2018 +0200 +++ b/build-aux/bootstrap Sun May 27 22:13:41 2018 +0200 @@ -47,6 +47,8 @@ me=$0 +default_gnulib_url=git://git.sv.gnu.org/gnulib + usage() { cat <<EOF Usage: $me [OPTION]... @@ -76,6 +78,37 @@ For build prerequisites, environment variables like \$AUTOCONF and \$AMTAR are honored. +Gnulib sources can be fetched in various ways: + + * If this package is in a git repository with a 'gnulib' submodule + configured, then that submodule is initialized and updated and sources + are fetched from there. If \$GNULIB_SRCDIR is set (directly or via + --gnulib-srcdir) and is a git repository, then it is used as a reference. + + * Otherwise, if \$GNULIB_SRCDIR is set (directly or via --gnulib-srcdir), + then sources are fetched from that local directory. If it is a git + repository and \$GNULIB_REVISION is set, then that revision is checked + out. + + * Otherwise, if this package is in a git repository with a 'gnulib' + submodule configured, then that submodule is initialized and updated and + sources are fetched from there. + + * Otherwise, if the 'gnulib' directory does not exist, Gnulib sources are + cloned into that directory using git from \$GNULIB_URL, defaulting to + $default_gnulib_url. + If \$GNULIB_REVISION is set, then that revision is checked out. + + * Otherwise, the existing Gnulib sources in the 'gnulib' directory are + used. If it is a git repository and \$GNULIB_REVISION is set, then that + revision is checked out. + +If you maintain a package and want to pin a particular revision of the +Gnulib sources that has been tested with your package, then there are two +possible approaches: either configure a 'gnulib' submodule with the +appropriate revision, or set \$GNULIB_REVISION (and if necessary +\$GNULIB_URL) in $me.conf. + Running without arguments will suffice in most cases. EOF } @@ -637,8 +670,8 @@ if test -z "$GNULIB_REVISION"; then git clone -h 2>&1 | grep -- --depth > /dev/null && shallow='--depth 2' fi - git clone $shallow ${GNULIB_URL:-git://git.sv.gnu.org/gnulib} \ - "$gnulib_path" || cleanup_gnulib + git clone $shallow ${GNULIB_URL:-$default_gnulib_url} "$gnulib_path" \ + || cleanup_gnulib trap - 1 2 13 15 fi