From ba54565ba6e39085ef0cbf475d258d2bc0ffa9a2 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Wed, 27 Nov 2024 10:15:25 +0100 Subject: [PATCH] Add installation information for the tarball users and from a git checkout. We want to have an INSTALL file that contains installation instructions for the tarball users. These instructions are necessarily package specific, because they need to list the prerequisites or reference the DEPENDENCIES file. Additionally, many people who are not aware that tarballs are the primary means for source code distribution of GNU packages check out the git repository and then expect to see instructions for installing from that git checkout in the INSTALL file. See e.g. . Unfortunately, both Automake (with strictness option = 'gnu') and 'bootstrap' both contain code to copy the generic (not package specific) installation instructions to the file 'INSTALL'. This is not what we want, so we disable it. (Other packages handle this issue by putting part of the installation instructions into the README file. This is suboptimal, because this is not what the README file is for.) * autogen.sh: Import INSTALL.generic from gnulib. * INSTALL: Entirely rewritten, based on poke/INSTALL. * Makefile.am (EXTRA_DIST): Add INSTALL.generic. --- .gitignore | 9 +- ChangeLog | 7 ++ INSTALL | 274 +++++++++--------------------------------------------------- Makefile.am | 2 +- autogen.sh | 2 + 5 files changed, 55 insertions(+), 239 deletions(-) rewrite INSTALL (99%) diff --git a/.gitignore b/.gitignore index 0785e5f..b79173c 100644 --- a/.gitignore +++ b/.gitignore @@ -6,10 +6,11 @@ \#*# # Files brought in by gnulib-tool: -m4/musl.m4 -m4/relocatable-lib.m4 -m4/sigaltstack.m4 -m4/stack-direction.m4 +/m4/musl.m4 +/m4/relocatable-lib.m4 +/m4/sigaltstack.m4 +/m4/stack-direction.m4 +/INSTALL.generic # Files generated by the autotools: /aclocal.m4 diff --git a/ChangeLog b/ChangeLog index d242a58..3b01409 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2024-11-27 Bruno Haible + Add installation information for the tarball users and from a git checkout. + * autogen.sh: Import INSTALL.generic from gnulib. + * INSTALL: Entirely rewritten, based on poke/INSTALL. + * Makefile.am (EXTRA_DIST): Add INSTALL.generic. + +2024-11-27 Bruno Haible + Distribute DEPENDENCIES. * Makefile.am (EXTRA_DIST): Add DEPENDENCIES. diff --git a/INSTALL b/INSTALL dissimilarity index 99% index 04222b1..1d4b642 100644 --- a/INSTALL +++ b/INSTALL @@ -1,234 +1,40 @@ -Basic Installation -================== - - These are generic installation instructions. - - The ‘configure’ shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a ‘Makefile’ in each directory of the package. -It may also create one or more ‘.h’ files containing system-dependent -definitions. Finally, it creates a shell script ‘config.status’ that -you can run in the future to recreate the current configuration, a file -‘config.cache’ that saves the results of its tests to speed up -reconfiguring, and a file ‘config.log’ containing compiler output -(useful mainly for debugging ‘configure’). - - If you need to do unusual things to compile the package, please try -to figure out how ‘configure’ could check whether to do them, and mail -diffs or instructions to the address given in the ‘README’ so they can -be considered for the next release. If at some point ‘config.cache’ -contains results you don't want to keep, you may remove or edit it. - - The file ‘configure.in’ is used to create ‘configure’ by a program -called ‘autoconf’. You only need ‘configure.in’ if you want to change -it or regenerate ‘configure’ using a newer version of ‘autoconf’. - -The simplest way to compile this package is: - - 1. ‘cd’ to the directory containing the package's source code and type - ‘./configure’ to configure the package for your system. If you're - using ‘csh’ on an old version of System V, you might need to type - ‘sh ./configure’ instead to prevent ‘csh’ from trying to execute - ‘configure’ itself. - - Running ‘configure’ takes awhile. While running, it prints some - messages telling which features it is checking for. - - 2. Type ‘make’ to compile the package. - - 3. Optionally, type ‘make check’ to run any self-tests that come with - the package. - - 4. Type ‘make install’ to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing ‘make clean’. To also remove the - files that ‘configure’ created (so you can compile the package for - a different kind of computer), type ‘make distclean’. There is - also a ‘make maintainer-clean’ target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the ‘configure’ script does not know about. You can give ‘configure’ -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the ‘env’ program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of ‘make’ that -supports the ‘VPATH’ variable, such as GNU ‘make’. ‘cd’ to the -directory where you want the object files and executables to go and run -the ‘configure’ script. ‘configure’ automatically checks for the -source code in the directory that ‘configure’ is in and in ‘..’. - - If you have to use a ‘make’ that does not supports the ‘VPATH’ -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use ‘make distclean’ before reconfiguring for another -architecture. - - On MacOS X 10.5 and later systems, you can create libraries and -executables that work on multiple system types--known as "fat" or -"universal" binaries--by specifying multiple '-arch' options to the -compiler but only a single '-arch' option to the preprocessor. Like -this: - - ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CPP="gcc -E" CXXCPP="g++ -E" - - This is not guaranteed to produce working output in all cases. You -may have to build one architecture at a time and combine the results -using the 'lipo' tool if you have problems. - -Installation Names -================== - - By default, ‘make install’ will install the package's files in -‘/usr/local/bin’, ‘/usr/local/man’, etc. You can specify an -installation prefix other than ‘/usr/local’ by giving ‘configure’ the -option ‘--prefix=PATH’. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give ‘configure’ the option ‘--exec-prefix=PATH’, the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like ‘--bindir=PATH’ to specify different values for particular -kinds of files. Run ‘configure --help’ for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving ‘configure’ the -option ‘--program-prefix=PREFIX’ or ‘--program-suffix=SUFFIX’. - -Optional Features -================= - - Some packages pay attention to ‘--enable-FEATURE’ options to -‘configure’, where FEATURE indicates an optional part of the package. -They may also pay attention to ‘--with-PACKAGE’ options, where PACKAGE -is something like ‘gnu-as’ or ‘x’ (for the X Window System). The -‘README’ should mention any ‘--enable-’ and ‘--with-’ options that the -package recognizes. - - For packages that use the X Window System, ‘configure’ can usually -find the X include and library files automatically, but if it doesn't, -you can use the ‘configure’ options ‘--x-includes=DIR’ and -‘--x-libraries=DIR’ to specify their locations. - - For packages that use the GNU libiconv library, you can use the -‘configure’ option ‘--with-libiconv-prefix’ to specify the prefix you -used while installing libiconv. - -Particular Systems -================== - - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in order -to use an ANSI C compiler: - - ./configure CC="cc -Ae" - -and if that doesn't work, install pre-built binaries of GCC for HP-UX. - - On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its ‘’ header file. The option ‘-nodtk’ can be used as -a workaround. If GNU CC is not installed, it is therefore recommended -to try - - ./configure CC="cc" - -and if that doesn't work, try - - ./configure CC="cc -nodtk" - - On AIX 3, the C include files by default don't define some necessary -prototype declarations. If GNU CC is not installed, it is recommended to -use the following options: - - ./configure CC="xlc -D_ALL_SOURCE" - - On BeOS, user installed software goes in /boot/home/config, not -/usr/local. It is recommended to use the following options: - - ./configure --prefix=/boot/home/config - -Specifying the System Type -========================== - - There may be some features ‘configure’ can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually ‘configure’ can figure that out, but if it prints -a message saying it can not guess the host type, give it the -‘--host=TYPE’ option. TYPE can either be a short name for the system -type, such as ‘sun4’, or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file ‘config.sub’ for the possible values of each field. If -‘config.sub’ isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the ‘--target=TYPE’ option to select the type of system they will -produce code for and the ‘--build=TYPE’ option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for ‘configure’ scripts to share, -you can create a site shell script called ‘config.site’ that gives -default values for variables like ‘CC’, ‘cache_file’, and ‘prefix’. -‘configure’ looks for ‘PREFIX/share/config.site’ if it exists, then -‘PREFIX/etc/config.site’ if it exists. Or, you can set the -‘CONFIG_SITE’ environment variable to the location of the site script. -A warning: not all ‘configure’ scripts look for a site script. - -Operation Controls -================== - - ‘configure’ recognizes the following options to control how it -operates. - -‘--cache-file=FILE’ - Use and save the results of the tests in FILE instead of - ‘./config.cache’. Set FILE to ‘/dev/null’ to disable caching, for - debugging ‘configure’. - -‘--help’ - Print a summary of the options to ‘configure’, and exit. - -‘--quiet’ -‘--silent’ -‘-q’ - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to ‘/dev/null’ (any error - messages will still be shown). - -‘--srcdir=DIR’ - Look for the package's source code in directory DIR. Usually - ‘configure’ can determine that directory automatically. - -‘--version’ - Print the version of Autoconf used to generate the ‘configure’ - script, and exit. - -‘configure’ also accepts some other, not widely useful, options. - +This file explains how to install GNU libsigsegv from a tarball. +(If you have checked out the source code repository, start by reading the +file HACKING instead.) + + +Prerequisites +============= + +Before starting the installation, install the prerequisites listed in the +file DEPENDENCIES. You need to have at least those marked as 'Mandatory' +installed. + + +Installation +============ + +Then, you can run 'configure': + + $ mkdir build/ && cd build + $ ../configure + +Here, you can give as arguments to 'configure' + + - configure options, as listen in the 'configure --help' output, + - Makefile variable assignments for building the binaries, as + described in the INSTALL.generic file. + +If you are in a 64-bit multilib system with support for building 32-bit +binaries, you can build a 32-bit poke configuring like this: + + $ ../configure CC="gcc -m32" + +You find a set of known-to-work variable settings for various platforms +in https://gitlab.com/ghwiki/gnow-how/-/wikis/Platforms/Configuration . + +Finally: + + $ make + $ make check + $ make install diff --git a/Makefile.am b/Makefile.am index 92218d5..a9cc4e9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -26,7 +26,7 @@ SUBDIRS = src tests EXTRA_DIST = \ ChangeLog.1 PORTING \ - DEPENDENCIES INSTALL.windows HACKING JOIN-GNU \ + DEPENDENCIES INSTALL.generic INSTALL.windows HACKING JOIN-GNU \ autogen.sh DISTCLEANFILES = termbold termnorm diff --git a/autogen.sh b/autogen.sh index c21b6d6..7a3a23f 100755 --- a/autogen.sh +++ b/autogen.sh @@ -70,6 +70,8 @@ if test $skip_gnulib = false; then for file in config.guess config.sub; do $GNULIB_TOOL --copy-file build-aux/$file; chmod a+x build-aux/$file done + # Fetch INSTALL.generic. + $GNULIB_TOOL --copy-file doc/INSTALL.UTF-8 INSTALL.generic fi # Generate aclocal.m4. -- 2.11.4.GIT