Re: Specifying Names manual node has a different header

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

 



-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

According to Russ Allbery on 3/12/2009 10:19 PM:

Hello, and sorry for my delay,

> A Debian user noticed that the Specifying Names node in the Autoconf
> manual has a heading of "Specifying the System Type."  The nodes don't
> necessarily have the same name as the page titles, I realize, but in this
> case I think the node name is a bit confusing.  "Specifying Names" sounds
> like a rather more generic topic than system types.  I think it may be
> worthwhile to rename this node to "Specifying the System Type" (or,
> shorter, "Specifying System Types") to match its heading.

Thanks for the report.  Even worse, there are two nodes with an entry of
@section Specifying the System Type, one in the chapter "Manual
Configuration" (@node Specifying Names), and one in the chapter "Running
`configure' scripts" (@node System Type).  I'll be pushing this soon.

- --
Don't work too hard, make some time for fun as well!

Eric Blake             ebb9@xxxxxxx
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Public key at home.comcast.net/~ericblake/eblake.gpg
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkm/mfQACgkQ84KuGfSFAYAt3QCdHv7hte0bfKlHwDgQ3mio8e15
wfgAoNLJdU2N+OERuspEq7ueo/BaBrIR
=Q4+p
-----END PGP SIGNATURE-----
>From e5f657f31e671e95c4989a2840d5053ed1f3cda6 Mon Sep 17 00:00:00 2001
From: Eric Blake <ebb9@xxxxxxx>
Date: Tue, 17 Mar 2009 06:38:07 -0600
Subject: [PATCH] Improve confusing section names.

* doc/autoconf.texi (Specifying Names): Rename node...
(Specifying Target Triplets): ...to this.
(Generic Programs): Adjust references.
* doc/install.texi (System Type): Touch up formatting.
* THANKS: Update.
Reported by Tim Freeman, in http://bugs.debian.org/312873.

Signed-off-by: Eric Blake <ebb9@xxxxxxx>
---
 ChangeLog         |    8 ++++++++
 THANKS            |    1 +
 doc/autoconf.texi |   28 +++++++++++++++-------------
 doc/install.texi  |    5 +++--
 4 files changed, 27 insertions(+), 15 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 8f9cd54..9a5fd5d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2009-03-17  Eric Blake  <ebb9@xxxxxxx>

+	Improve confusing section names.
+	* doc/autoconf.texi (Specifying Names): Rename node...
+	(Specifying Target Triplets): ...to this.
+	(Generic Programs): Adjust references.
+	* doc/install.texi (System Type): Touch up formatting.
+	* THANKS: Update.
+	Reported by Tim Freeman, in http://bugs.debian.org/312873.
+
 	Remove historical inaccuracy.
 	* doc/autoconf.texi (Portable Shell): Don't perpetuate myth about
 	#!/bin/sh needing a space.
diff --git a/THANKS b/THANKS
index 5cb10cb..c3e19a2 100644
--- a/THANKS
+++ b/THANKS
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 874d139..e821cbd 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -537,7 +537,7 @@ Top

 Manual Configuration

-* Specifying Names::            Specifying the system type
+* Specifying Target Triplets::  Specifying target triplets
 * Canonicalizing::              Getting the canonical system type
 * Using System Type::           What to do with the system type

@@ -4058,7 +4058,7 @@ Generic Programs
 If the tool cannot be found with a prefix, and if the build and target
 types are equal, then it is also searched for without a prefix.

-As noted in @ref{Specifying Names, , Specifying the system type}, the
+As noted in @ref{Specifying Target Triplets}, the
 target is rarely specified, because most of the time it is the same
 as the host: it is the type of system for which any compiler tool in
 the package produces code.  What this macro looks for is,
@@ -4084,8 +4084,7 @@ Generic Programs

 When cross-compiling, this macro will issue a warning if no program
 prefixed with the host type could be found.
-For more information, see @ref{Specifying Names, , Specifying the
-system type}.
+For more information, see @ref{Specifying Target Triplets}.
 @end defmac

 @defmac AC_CHECK_TARGET_TOOLS (@var{variable}, @var{progs-to-check-for}, @
@@ -4118,8 +4117,7 @@ Generic Programs

 When cross-compiling, this macro will issue a warning if no program
 prefixed with the host type could be found.
-For more information, see @ref{Specifying Names, , Specifying the
-system type}.
+For more information, see @ref{Specifying Target Triplets}.
 @end defmac

 @anchor{AC_PATH_PROG}
@@ -4197,8 +4195,7 @@ Generic Programs

 When cross-compiling, this macro will issue a warning if no program
 prefixed with the host type could be found.
-For more information, see @ref{Specifying Names, , Specifying the
-system type}.
+For more information, see @ref{Specifying Target Triplets}.
 @end defmac


@@ -18972,18 +18969,22 @@ Manual Configuration
 Autoconf provides a uniform method for handling unguessable features.

 @menu
-* Specifying Names::            Specifying the system type
+* Specifying Target Triplets::  Specifying target triplets
 * Canonicalizing::              Getting the canonical system type
 * Using System Type::           What to do with the system type
 @end menu

-@node Specifying Names
-@section Specifying the System Type
+@node Specifying Target Triplets
+@section Specifying target triplets
 @cindex System type
+@cindex Target triplet
+@c This node used to be named Specifying Names.  The @anchor allows old
+@c links to still work.
+@anchor{Specifying Names}

 Autoconf-generated
 @command{configure} scripts can make decisions based on a canonical name
-for the system type, which has the form:
+for the system type, or @dfn{target triplet}, which has the form:
 @samp{@var{cpu}-@var{vendor}-@var{os}}, where @var{os} can be
 @samp{@var{system}} or @samp{@var{kernel}-@var{system}}

@@ -18993,7 +18994,8 @@ Specifying Names
 command or symbols predefined by the C preprocessor.

 Alternately, the user can specify the system type with command line
-arguments to @command{configure}.  Doing so is necessary when
+arguments to @command{configure} (@pxref{System Type}.  Doing so is
+necessary when
 cross-compiling.  In the most complex case of cross-compiling, three
 system types are involved.  The options to specify them are:

diff --git a/doc/install.texi b/doc/install.texi
index d498639..a51882c 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -7,7 +7,7 @@
 @unnumbered Installation Instructions

 Copyright @copyright{} 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004,
-2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.

 This file is free documentation; the Free Software Foundation gives
 unlimited permission to copy, distribute and modify it.
@@ -242,7 +242,8 @@ System Type
 where @var{system} can have one of these forms:

 @example
-@var{os} @var{kernel}-@var{os}
+@var{os}
+@var{kernel}-@var{os}
 @end example

 See the file @file{config.sub} for the possible values of each field.
-- 
1.6.1.2

_______________________________________________
Autoconf mailing list
Autoconf@xxxxxxx
http://lists.gnu.org/mailman/listinfo/autoconf

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

  Powered by Linux