bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Updated INSTALL from Autoconf


From: Eric Blake
Subject: Re: Updated INSTALL from Autoconf
Date: Tue, 26 Aug 2008 21:44:23 +0000 (UTC)
User-agent: Loom/3.14 (http://gmane.org/)

Bruno Haible <bruno <at> clisp.org> writes:

> > Is this the sort of patch better suited to an upstream fix in install.texi
> > in autoconf (ie. fold the @firstparagraphindent into the .texi file,
> > rather than creating a temporary file in the gnulib Makefile rule)?
> 
> I don't think so: The install.texi file is also included by the autoconf
> documentation (autoconf.info). However, @firstparagraphindent is a global
> setting pertaining to an entire manual.

Ah, but install.texi explicitly includes an '@ifclear autoconf' directive to 
distinguish between options that apply only to INSTALL vs. the entire manual.

I'm applying this; it resyncs to further changes that were made upstream in 
autoconf's install.texi today.

From: Eric Blake <address@hidden>
Date: Tue, 26 Aug 2008 15:42:04 -0600
Subject: [PATCH] doc/INSTALL: resync from autoconf

* doc/Makefile (INSTALL, INSTALL.ISO, INSTALL.UTF-8): Simplify.
(INSTALL_PRELUDE): Delete; this is done more efficiently by
moving...
* install.texi [!autoconf]: ...here.  Resync from autoconf.
* INSTALL: Regenerate.
* INSTALL.ISO: New file.
* INSTALL.UTF-8: Likewise.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog         |   11 ++
 doc/INSTALL       |   62 +++++++----
 doc/INSTALL.ISO   |  291 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/INSTALL.UTF-8 |  291 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/Makefile      |   15 +--
 doc/install.texi  |   26 +++++-
 6 files changed, 661 insertions(+), 35 deletions(-)
 create mode 100644 doc/INSTALL.ISO
 create mode 100644 doc/INSTALL.UTF-8

diff --git a/ChangeLog b/ChangeLog
index 409ae14..1f25783 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2008-08-26  Eric Blake  <address@hidden>
+
+       doc/INSTALL: resync from autoconf
+       * doc/Makefile (INSTALL, INSTALL.ISO, INSTALL.UTF-8): Simplify.
+       (INSTALL_PRELUDE): Delete; this is done more efficiently by
+       moving...
+       * install.texi [!autoconf]: ...here.  Resync from autoconf.
+       * INSTALL: Regenerate.
+       * INSTALL.ISO: New file.
+       * INSTALL.UTF-8: Likewise.
+
 2008-08-26  Jim Meyering  <address@hidden>
 
        GNUmakefile: cfg.mk definitions override default autoreconf-rerun policy
diff --git a/doc/INSTALL b/doc/INSTALL
index 47ab4eb..8b82ade 100644
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -4,13 +4,13 @@ Installation Instructions
 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
 2006, 2007, 2008 Free Software Foundation, Inc.
 
-This file is free documentation; the Free Software Foundation gives
+   This file is free documentation; the Free Software Foundation gives
 unlimited permission to copy, distribute and modify it.
 
 Basic Installation
 ==================
 
-Briefly, the shell commands `./configure; make; make install' should
+   Briefly, the shell commands `./configure; make; make install' should
 configure, build, and install this package.  The following
 more-detailed instructions are generic; see the `README' file for
 instructions specific to this package.
@@ -73,9 +73,9 @@ The simplest way to compile this package is:
 Compilers and Options
 =====================
 
-Some systems require unusual options for compilation or linking that the
-`configure' script does not know about.  Run `./configure --help' for
-details on some of the pertinent environment variables.
+   Some systems require unusual options for compilation or linking that
+the `configure' script does not know about.  Run `./configure --help'
+for details on some of the pertinent environment variables.
 
    You can give `configure' initial values for configuration parameters
 by setting variables in the command line or in the environment.  Here
@@ -88,7 +88,7 @@ is an example:
 Compiling For Multiple Architectures
 ====================================
 
-You can compile the package for more than one kind of computer at the
+   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 can use GNU `make'.  `cd' to the
 directory where you want the object files and executables to go and run
@@ -117,7 +117,7 @@ using the `lipo' tool if you have problems.
 Installation Names
 ==================
 
-By default, `make install' installs the package's commands under
+   By default, `make install' installs the package's commands under
 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 can specify an installation prefix other than `/usr/local' by giving
 `configure' the option `--prefix=PREFIX'.
@@ -140,7 +140,7 @@ option `--program-prefix=PREFIX' or `--program-
suffix=SUFFIX'.
 Optional Features
 =================
 
-Some packages pay attention to `--enable-FEATURE' options to
+   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
@@ -155,9 +155,9 @@ you can use the `configure' options `--x-includes=DIR' and
 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:
+   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"
 
@@ -177,11 +177,11 @@ and if that doesn't work, try
 Specifying the System Type
 ==========================
 
-There may be some features `configure' cannot figure out automatically,
-but needs to determine by the type of machine the package will run on.
-Usually, assuming the package is built to be run on the _same_
-architectures, `configure' can figure that out, but if it prints a
-message saying it cannot guess the machine type, give it the
+   There may be some features `configure' cannot figure out
+automatically, but needs to determine by the type of machine the package
+will run on.  Usually, assuming the package is built to be run on the
+_same_ architectures, `configure' can figure that out, but if it prints
+a message saying it cannot guess the machine type, give it the
 `--build=TYPE' option.  TYPE can either be a short name for the system
 type, such as `sun4', or a canonical name which has the form:
 
@@ -207,9 +207,9 @@ eventually be run) with `--host=TYPE'.
 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'.
+   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.
@@ -218,7 +218,7 @@ A warning: not all `configure' scripts look for a site 
script.
 Defining Variables
 ==================
 
-Variables not defined in a site shell script can be set in the
+   Variables not defined in a site shell script can be set in the
 environment passed to `configure'.  However, some packages may run
 configure again during the build, and the customized values of these
 variables may be lost.  In order to avoid this problem, you should set
@@ -237,11 +237,19 @@ an Autoconf bug.  Until the bug is fixed you can use this 
workaround:
 `configure' Invocation
 ======================
 
-`configure' recognizes the following options to control how it operates.
+   `configure' recognizes the following options to control how it
+operates.
 
 `--help'
 `-h'
-     Print a summary of the options to `configure', and exit.
+     Print a summary of all of the options to `configure', and exit.
+
+`--help=short'
+`--help=recursive'
+     Print a summary of the options unique to this package's
+     `configure', and exit.  The `short' variant lists options used
+     only in the top level, while the `recursive' variant lists options
+     also present in any nested packages.
 
 `--version'
 `-V'
@@ -268,6 +276,16 @@ an Autoconf bug.  Until the bug is fixed you can use this 
workaround:
      Look for the package's source code in directory DIR.  Usually
      `configure' can determine that directory automatically.
 
+`--prefix=DIR'
+     Use DIR as the installation prefix.  *Note Installation Names::
+     for more details, including other options available for fine-tuning
+     the installation locations.
+
+`--no-create'
+`-n'
+     Run the configure checks, but stop before creating any output
+     files.
+
 `configure' also accepts some other, not widely useful, options.  Run
 `configure --help' for more details.
 
diff --git a/doc/INSTALL.ISO b/doc/INSTALL.ISO
new file mode 100644
index 0000000..b402929
diff --git a/doc/INSTALL.UTF-8 b/doc/INSTALL.UTF-8
new file mode 100644
index 0000000..6a8850a
diff --git a/doc/Makefile b/doc/Makefile
index a2b36e4..30961d0 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -24,26 +24,17 @@ html: $(doc).html
 dvi: $(doc).dvi
 pdf: $(doc).pdf
 
-INSTALL_PRELUDE = \
-  echo '@firstparagraphindent insert';
-
 # INSTALL file with old ASCII quotation marks (looks ugly on modern machines).
 INSTALL: install.texi
-       { $(INSTALL_PRELUDE) cat $<; } > tmp.texi
-       $(MAKEINFO) --plaintext --no-validate tmp.texi > $@
-       rm -f tmp.texi
+       $(MAKEINFO) --plaintext --no-validate $< > $@
 
 # INSTALL file with ISO 646 or ISO 8859 quotation marks.
 INSTALL.ISO: install.texi
-       { $(INSTALL_PRELUDE) cat $<; } > tmpi.texi
-       $(MAKEINFO) --plaintext --no-validate tmpi.texi | sed -e "s/\`\([^']
*\)'/'\1'/g" > $@
-       rm -f tmpi.texi
+       $(MAKEINFO) --plaintext --no-validate $< | sed -e "s/\`\([^']
*\)'/'\1'/g" > $@
 
 # INSTALL file wit ISO 10646 (Unicode) quotation marks.
 INSTALL.UTF-8: install.texi
-       { $(INSTALL_PRELUDE) cat $<; } > tmpu.texi
-       $(MAKEINFO) --plaintext --no-validate tmpu.texi | sed -e "s/\`\([^']
*\)'/‘\1’/g" > $@
-       rm -f tmpu.texi
+       $(MAKEINFO) --plaintext --no-validate $< | sed -e "s/\`\([^']
*\)'/‘\1’/g" > $@
 
 GNULIB_TEXI_FILES = $(filter-out maintain.texi make-stds.texi 
standards.texi,$(wildcard *.texi)) $(wildcard posix-headers/*.texi) $(wildcard 
posix-functions/*.texi) $(wildcard glibc-headers/*.texi) $(wildcard glibc-
functions/*.texi)
 
diff --git a/doc/install.texi b/doc/install.texi
index 070291c..a344b28 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -2,6 +2,7 @@
 @c the INSTALL file.
 
 @ifclear autoconf
address@hidden insert
 
 @unnumbered Installation Instructions
 
@@ -294,7 +295,14 @@ operates.
 @table @option
 @item --help
 @itemx -h
-Print a summary of the options to @command{configure}, and exit.
+Print a summary of all of the options to @command{configure}, and exit.
+
address@hidden --help=short
address@hidden --help=recursive
+Print a summary of the options unique to this package's
address@hidden, and exit.  The @code{short} variant lists options
+used only in the top level, while the @code{recursive} variant lists
+options also present in any nested packages.
 
 @item --version
 @itemx -V
@@ -321,8 +329,24 @@ will still be shown).
 @item address@hidden
 Look for the package's source code in directory @var{dir}.  Usually
 @command{configure} can determine that directory automatically.
+
address@hidden address@hidden
+Use @var{dir} as the installation prefix.  @ref{Installation Names}
+for more details, including other options available for fine-tuning
+the installation locations.
+
address@hidden --no-create
address@hidden -n
+Run the configure checks, but stop before creating any output files.
 @end table
 
 @noindent
 @command{configure} also accepts some other, not widely useful, options.
 Run @samp{configure --help} for more details.
+
address@hidden Local Variables:
address@hidden fill-column: 72
address@hidden ispell-local-dictionary: "american"
address@hidden indent-tabs-mode: nil
address@hidden whitespace-check-buffer-indent: nil
address@hidden End:
-- 
1.6.0







reply via email to

[Prev in Thread] Current Thread [Next in Thread]