autoconf-patches
[Top][All Lists]
Advanced

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

[PATCH] docs: link to GNU Coding Standards in intro


From: Eric Blake
Subject: [PATCH] docs: link to GNU Coding Standards in intro
Date: Wed, 8 Sep 2010 09:17:48 -0600

* doc/autoconf.texi (Introduction): Actually link to the
standards.  Make other references consistent.

Signed-off-by: Eric Blake <address@hidden>
---

> I've noticed that the manual mentions GNU Coding Standards in several
> locations, including chapter 1, but without any link.  If anyone wants
> to beat me to a patch, I think we should follow the example of Automake
> http://www.gnu.org/software/automake/manual/automake.html#GNU-Build-System
> and include a link to the GCS on our first mention.

Actually, we already had several links, but not where I was first looking.
Here's what I'm pushing.

 ChangeLog         |    4 ++++
 doc/autoconf.texi |    9 +++++----
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 77d513c..c874eab 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2010-09-08  Eric Blake  <address@hidden>

+       docs: link to GNU Coding Standards in intro
+       * doc/autoconf.texi (Introduction): Actually link to the
+       standards.  Make other references consistent.
+
        docs: mention traditional awk limitation
        * doc/autoconf.texi (Limitations of Usual Tools) <awk>: Mention
        that traditional awk lacks ENVIRON.  Add reference to awk manual.
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 24c6e14..99054c5 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -728,7 +728,8 @@ Introduction
 the resulting @file{configure}.  Even packages that don't use Autoconf
 will generally provide a @file{configure} script, and the most common
 complaint about these alternative home-grown scripts is that they fail
-to meet one or more of the GNU Coding Standards that users
+to meet one or more of the GNU Coding Standars (@pxref{Configuration, , ,
+standards, The GNU Coding Standards}) that users
 have come to expect from Autoconf-generated @file{configure} scripts.

 The Metaconfig package is similar in purpose to Autoconf, but the
@@ -14671,7 +14672,7 @@ Portable Shell

 The set of external programs you should run in a @command{configure} script
 is fairly small.  @xref{Utilities in Makefiles, , Utilities in
-Makefiles, standards, GNU Coding Standards}, for the list.  This
+Makefiles, standards, The GNU Coding Standards}, for the list.  This
 restriction allows users to start out with a fairly small set of
 programs and build the rest, avoiding too many interdependencies between
 packages.
@@ -20121,7 +20122,7 @@ Portable C and C++

 Program portability is a huge topic, and this section can only briefly
 introduce common pitfalls.  @xref{System Portability, , Portability
-between System Types, standards, GNU Coding Standards}, for
+between System Types, standards, The GNU Coding Standards}, for
 more information.

 @menu
@@ -21393,7 +21394,7 @@ Site Details
 runtime, rather than at compile time.  Runtime configuration is more
 convenient for users and makes the configuration process simpler than
 getting the information while configuring.  @xref{Directory Variables, ,
-Variables for Installation Directories, standards, GNU Coding
+Variables for Installation Directories, standards, The GNU Coding
 Standards}, for more information on where to put data files.

 @node Transforming Names
-- 
1.7.2.2




reply via email to

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