Rename autogen.sh to bootstrap to follow GNU guidelines

Update relevant document files to describe 'boostrap' and 'configure'.
astyle-formatting
Nate Bargmann 2017-07-27 21:30:13 -05:00
rodzic f1c0267867
commit a8c56853d3
10 zmienionych plików z 56 dodań i 44 usunięć

Wyświetl plik

@ -195,7 +195,7 @@ contains results you don't want to keep, you may remove or edit it.
The file `configure.ac' is used to create `configure' by a program The file `configure.ac' is used to create `configure' by a program
called `autoreconf'. You only need `configure.ac' if you want to change called `autoreconf'. You only need `configure.ac' if you want to change
it or regenerate `configure' using a newer version of `autoconf'. This it or regenerate `configure' using a newer version of `autoconf'. This
project uses a custom `autogen.sh' for running autoreconf in a developer's project uses a custom `bootstrap' for running autoreconf in a developer's
checkout of Hamlib from a source repository. checkout of Hamlib from a source repository.
Advanced installation options. Advanced installation options.

1
NEWS
Wyświetl plik

@ -11,6 +11,7 @@ Version 3.2
* Fix ft991_get_mode, Mike, W9MDB * Fix ft991_get_mode, Mike, W9MDB
* New model, FT-891. Mike, W9MDB * New model, FT-891. Mike, W9MDB
* Build instructions and test script for Python3 * Build instructions and test script for Python3
* Rename autogen.sh to bootsrap and don't call configure
Version 3.1 Version 3.1
2016-12-31 2016-12-31

Wyświetl plik

@ -176,7 +176,7 @@ Git checkout:
Please read the beginning of README.developer file, especially Section 1 which Please read the beginning of README.developer file, especially Section 1 which
details the Git checkout, the required tools and versions (very important or details the Git checkout, the required tools and versions (very important or
make won't even work!), and how to use the autogen.sh script. make won't even work!), and how to use the bootstrap script.
Structure: Structure:

Wyświetl plik

@ -269,25 +269,30 @@ make sure they are matching *at least* the version shown above.
1.3. configure and build stage 1.3. configure and build stage
It is important to note that the Git repository holds no autogenerated It is important to note that the Git repository holds no Autotools
files, i.e. configure, config.guess, Makefile, etc. Hence after a fresh generated files, i.e. configure, config.guess, Makefile, etc. Hence
checkout, you'll have to generate those files. after a fresh checkout, you'll have to generate those files.
To proceed, first edit the autogen.sh script, and set appropriately the To proceed, first edit the bootstrap script, and set appropriately the
AUTORECONF, AUTOMAKE, and LIBTOOLIZE variables with the required versions seen AUTORECONF, AUTOMAKE, and LIBTOOLIZE variables with the required versions seen
in the previous section (most systems will be fine with the default names, in the previous section (most systems will be fine with the default names,
only do this if a problem arises and please let us know). only do this if a problem arises and please let us know).
cd hamlib cd hamlib
sh ./autogen.sh [CFLAGS="-g -O0"] ./bootstrap
./configure [CFLAGS="-g -O0"]
make make
make install make install
Note: Depending on the value of '--prefix' passed to 'configure', superuser
(root) privileges may be needed for 'make install'.
If you don't want the build files cluttering the source directories, do the If you don't want the build files cluttering the source directories, do the
following in the same parent directory of hamlib: following in the same parent directory of hamlib:
mkdir build && cd build mkdir build && cd build
sh ../hamlib/autogen.sh [CFLAGS="-g -O0"] ../hamlib/bootstrap
../hamlib/configure [CFLAGS="-g -O0"]
make make
make install make install
@ -297,7 +302,7 @@ optional as shown using the square brackets..
This will keep the binary output files separate from the source tree and aid This will keep the binary output files separate from the source tree and aid
in development by reducing clutter in the source tree. in development by reducing clutter in the source tree.
Once you've run `autogen.sh', make sure you've got some recent config.guess Once you've run `bootstrap', make sure you've got some recent config.guess
and config.sub (needed to guess your system type). Anything of at least and config.sub (needed to guess your system type). Anything of at least
year 2004 should be fine, unless you run some exotic hardware/software system year 2004 should be fine, unless you run some exotic hardware/software system
(modern Linux distributions and Cygwin keep these up to date): (modern Linux distributions and Cygwin keep these up to date):
@ -305,7 +310,7 @@ year 2004 should be fine, unless you run some exotic hardware/software system
./config.guess --version ./config.guess --version
./config.sub --version ./config.sub --version
The '--prefix' option to `autogen.sh' is optional and not shown as it defaults The '--prefix' option to `configure' is optional and not shown as it defaults
to /usr/local. Convention is that locally built packages be installed in to /usr/local. Convention is that locally built packages be installed in
/usr/local away from distribution installed packages. The 'CFLAGS="-g -O0"' /usr/local away from distribution installed packages. The 'CFLAGS="-g -O0"'
environment variable generates less optimized binaries with the '-O0' while the environment variable generates less optimized binaries with the '-O0' while the
@ -313,17 +318,17 @@ environment variable generates less optimized binaries with the '-O0' while the
debugging info for gdb. debugging info for gdb.
Additionally, you may want to add the '--with-perl-binding' or Additionally, you may want to add the '--with-perl-binding' or
'--with-python-binding' or '--with-tcl-binding' if you are interested in '--with-python-binding' or '--with-tcl-binding' or '--with-lua-binding' if you are
Swig binding support for those scripting languages. interested in SWIG binding support for those scripting languages.
NOTE: The autogen.sh script has only to be run the first time after a fresh NOTE: The bootstrap script has only to be run the first time after a fresh
checkout or when a Makefile.am or other build file is modified or added. checkout or when a Makefile.am or other build file is modified or added.
For a Tcl build, add this if needed: For a Tcl build, add this if needed:
--with-tcl=/usr/lib/tcl8.2 --with-tcl=/usr/lib/tcl8.2
Note: C-shell users may have to run autogen.sh and make through a bourne Note: C-shell users may have to run bootstrap and make through a bourne
shell instead, or pass "SHELL=bash" as a parameter to make. shell instead, or pass "SHELL=bash" as a parameter to make.
Some basic testing is accomplished with the 'make check' target which will Some basic testing is accomplished with the 'make check' target which will

Wyświetl plik

@ -13,9 +13,13 @@ $ brew install automake autoconf libtool
Build Build
----- -----
Execute autogen.sh with the desired flags Execute bootstrap to generate the build system files
$ ./autogen.sh $ ./bootstrap
Then configure with the desired flags
$ ./configure
Then compile the hamlib files Then compile the hamlib files

Wyświetl plik

@ -95,7 +95,8 @@ release:
rc testing/release. rc testing/release.
* Build source tarball from a cleaned tree (as above): * Build source tarball from a cleaned tree (as above):
./autogen.sh ./bootstrap
./configure
make dist make dist
The resulting tarball--hamlib-3.y[.z].tar.gz--should be tested as much The resulting tarball--hamlib-3.y[.z].tar.gz--should be tested as much

Wyświetl plik

@ -18,6 +18,7 @@ List-Archive: <http://sourceforge.net/mailarchive/forum.php?forum=hamlib-develop
Date: Sun, 20 Jun 2004 15:25:24 -0400 Date: Sun, 20 Jun 2004 15:25:24 -0400
<revised by mjf Tue, 17 Aug, 2004> <revised by mjf Tue, 17 Aug, 2004>
<revised by n0nb Thu, 27 Jul 2017>
Found this to be helpful for building hamlib under Cygwin/Mingw32 for Found this to be helpful for building hamlib under Cygwin/Mingw32 for
linking with Windows apps: linking with Windows apps:
@ -28,14 +29,15 @@ Cygwin is fully updated):
$ export CC="gcc -mno-cygwin" $ export CC="gcc -mno-cygwin"
$ export CXX="g++ -mno-cygwin" $ export CXX="g++ -mno-cygwin"
$ ./autogen.sh --prefix=/usr/local \ $ ./bootstrap
$ ./configure --prefix=/usr/local \
--build=i686-pc-cygwin \ --build=i686-pc-cygwin \
--host=i686-pc-mingw32 \ --host=i686-pc-mingw32 \
--target=i686-pc-mingw32 --target=i686-pc-mingw32
Note: on subsequent runs you can replace ./autogen.sh with ./configure Note: on subsequent runs you will only need to run 'bootstrap' if
unless there are modifications to any .ac, .m4, or Makefile.am file. there are modifications to any .ac, .m4, or Makefile.am files.
In that case, "make clean", and re-run autogen as above. In that case, "make clean", and re-run 'bootstrap' as above.
# make # make

Wyświetl plik

@ -22,8 +22,9 @@ and available. It's time that we offer a means to generate bindings for
either version. This document will provide the steps for doing so. either version. This document will provide the steps for doing so.
NOTE: Developers and testers building from a Git clone/checkout will need NOTE: Developers and testers building from a Git clone/checkout will need
to bootstrap the build system by running the autogen.sh script. Source to bootstrap the build system by running the (appropriately named) 'bootstrap'
releases and source daily snapshots already have this step completed. script. Source releases and source daily snapshots already have this step
completed.
NOTE: The commands assume an out of tree build in a sibling directory to NOTE: The commands assume an out of tree build in a sibling directory to
the main source directory. Adjust your paths accordingly. Adjust your the main source directory. Adjust your paths accordingly. Adjust your

Wyświetl plik

@ -2,10 +2,6 @@
# Run this to generate all the initial makefiles, etc. # Run this to generate all the initial makefiles, etc.
# Enabling maintainer mode, as done when configure is run by this script,
# will cause the makefiles to be regenerated if any of the Makefile.am
# or configure.ac files are changed.
# Taken from glib CVS # Taken from glib CVS
# Change the following to match the versions installed on your system # Change the following to match the versions installed on your system
@ -76,10 +72,3 @@ echo "and generate the configure script."
"$AUTORECONF" -i "$AUTORECONF" -i
cd "$ORIGDIR" cd "$ORIGDIR"
if test -z "$*"; then
echo "I am going to run ./configure with no arguments - if you wish "
echo "to pass any to it, please specify them on the \"$0\" command line."
fi
"$SRCDIR/configure" "$@"

Wyświetl plik

@ -381,18 +381,26 @@ from which the build system consisting of @file{configure}, the
various @file{Makefile.in}s throughout the directory structure, and various @file{Makefile.in}s throughout the directory structure, and
the final @file{Makefile}s are generated. the final @file{Makefile}s are generated.
In the top-level directory is the @command{autogen.sh} script from In the top-level directory is the @command{bootstrap} script from
which the build system is @dfn{bootsrapped}---the process of building which the build system is @dfn{bootsrapped}---the process of
the Hamlib build system. At its completion @command{autogen.sh} will generating the Hamlib build system from @file{configure.ac} and the
run @command{configure} and will pass any command line arguments it various @file{Makefile.am}s. At its completion the
receives to @command{configure}. Environment variables intended for @command{configure} script will be present to configure the build
the compiler may also be set on the @command{autogen.sh} command line. system.
Next @command{configure} is run with any needed build options
(@command{configure --help} is useful) to enable certain features or
provide paths for locating needed build dependencies, etc.
Environment variables intended for the preprocessor and/or compiler
may also be set on the @command{configure} command line.
After the configuration is complete, the build may proceed with the After the configuration is complete, the build may proceed with the
@command{make} step as for the source tarballs above. Or @command{make} step as for the source tarballs above. Or
@command{configure --help} may be run, and @command{configure} run @command{configure --help} may be run, and @command{configure} run
again with specific options in which case the @file{Makefile}s will be again with specific options in which case the @file{Makefile}s will be
regenerated and the build will proceed. regenerated and the build can proceed with the new configuration.
@xref{configure}.
@node Other make targets @node Other make targets
@subsection Other @command{make} targets @subsection Other @command{make} targets
@ -472,9 +480,10 @@ manual for all the details.
@cindex Compiling for MS Windows 32 @cindex Compiling for MS Windows 32
@cindex MS Windows 32, compiling @cindex MS Windows 32, compiling
Currently compiling is done on an Xubuntu 10.10 virtual machine using Currently compiling is done on a Debian 8 (Jessie) virtual machine
@url{http://www.mingw.org/, MinGW32}. @file{README.build-win32} in using @url{http://www.mingw.org/, MinGW32}. @file{README.build-win32}
the @file{scripts} directory has details on how this is accomplished. in the @file{scripts} directory has details on how this is
accomplished.
Work is ongoing to correct build issues in the Work is ongoing to correct build issues in the
@url{http://www.cygwin.com/, Cygwin} environment running on MS @url{http://www.cygwin.com/, Cygwin} environment running on MS