Re: INSTALL nits

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


On 8/17/23 06:47, Gavin Smith wrote:

This is an improvement, but there are still a couple left (made with

Thanks, fixed with the attached further patch.

It would make sense to use "INSTALL.ISO"
as INSTALL in packages.

In old-fashioned packages perhaps. Nowadays a lot of packages use UTF-8 in their source files anyway.

I understand the reluctance to go beyond ASCII. Long ago I dealt with displays that couldn't even handle all of ASCII. But nowadays it generally isn't worth worrying about this stuff. Pretty much every builder can deal with the UTF-8 characters in INSTALL.

In the Texinfo package, the script is called "".  I doubt that
it offers more "fine-grained control" (as stated in the current text of
INSTALL) but appears to be just another name for this script.

That part of the documentation is talking about the practice, supported by Gnulib, of having two bootstrapping scripts. One,, fetches stuff from the network (and therefore has network and privacy concerns); the other,, is purely local. Often 'bootstrap' does both but you can run just one script or the other.

Another common practice is for 'bootstrap' to have --pull and --gen options, to do (network-based) pulling and (local-based) generation, instead of and, and where if you don't use either --pull or --gen than 'bootstrap' does both. Gnulib supports this too.

Is there any consistency in naming across different packages, i.e.
is "bootstrap" the most widely used name?

Hard to say. I prefer 'bootstrap' but there's definitely an '' and perhaps '' camp. Which is why Gnulib supports both.
From cb6fbab55de1e9660e110857ae248a70a8b48c5b Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert@xxxxxxxxxxx>
Date: Fri, 18 Aug 2023 19:47:06 -0700
Subject: [PATCH] Improve INSTALL format
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* doc/install.texi (Compilers and Options): Fix two @ref
instances that don’t work well when making INSTALL.
Problem noted by Gavin Smith in:
 doc/install.texi | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/doc/install.texi b/doc/install.texi
index b2ceae2e..f06ab17b 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -143,8 +143,12 @@ Here is an example:
 ./configure CC=gcc CFLAGS=-g LIBS=-lposix
 @end example
+See ``Defining Variables''
+@end ifplaintext
 @ref{Defining Variables}
+@end ifnotplaintext
 @ifset autoconf
 and @ref{Preset Output Variables}
 @end ifset
@@ -394,7 +398,13 @@ Look for the package's source code in directory @var{dir}.  Usually
 @command{configure} can determine that directory automatically.
 @item --prefix=@var{dir}
-Use @var{dir} as the installation prefix.  @ref{Installation Names}
+Use @var{dir} as the installation prefix.
+See ``Installation Names''
+@end ifplaintext
+@ref{Installation Names}
+@end ifnotplaintext
 for more details, including other options available for fine-tuning
 the installation locations.

[Index of Archives]     [GCC Help]     [Kernel Discussion]     [RPM Discussion]     [Red Hat Development]     [Yosemite News]     [Linux USB]     [Samba]

  Powered by Linux