autoconf-patches
[Top][All Lists]
Advanced

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

[PATCH] docs: mention gnulib portability docs


From: Eric Blake
Subject: [PATCH] docs: mention gnulib portability docs
Date: Mon, 13 Sep 2010 10:48:41 -0600

* doc/autoconf.texi (Function Portability, Header Portability):
Add external links to gnulib.

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

> > Hmm - autoconf already has a node Header Portability, where this
> > could be added.  But right now, gnulib's documentation is already
> > much more extensive than autoconf's, it may be easier to just point
> > to the gnulib manual with all its collected wisdom on these various
> > headers than to try and maintain this information in two separate
> > lists.
> Sure, that's a good possibility too.  My only nit was that a few
> things in the Autoconf manual are bit-rotting a bit, in comparison
> to the knowledge collected by gnulib.  A link would help this, too.

Rather than perpetually maintain two lists, I'm taking the link
approach.  I don't see any reason to nuke the existing autoconf
comments (they are, after all, still historically accurate even
if they describe issues no longer relevant to modern porting).

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

diff --git a/ChangeLog b/ChangeLog
index 781ea92..5b68441 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2010-09-13  Eric Blake  <address@hidden>
+
+       docs: mention gnulib portability docs
+       * doc/autoconf.texi (Function Portability, Header Portability):
+       Add external links to gnulib.
+
 2010-09-12  Fernando Carrijo  <address@hidden>  (tiny change)

        docs: fix minor typo and 'See See foo' instances
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 97c9eb0..62a17f7 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -4514,7 +4514,12 @@ Function Portability
 Most usual functions can either be missing, or be buggy, or be limited
 on some architectures.  This section tries to make an inventory of these
 portability issues.  By definition, this list always requires
-additions.  Please help us keeping it as complete as possible.
+additions.  A much more complete list is maintained by the Gnulib
+project (@pxref{Gnulib}), covering @ref{Function Substitutes, ,
+Current Posix Functions, gnulib, GNU gnulib}, @ref{Legacy Function
+Substitutes, , Legacy Functions, gnulib, GNU gnulib}, and @ref{Glibc
+Function Substitutes, , Glibc Functions, gnulib, GNU gnulib}.  Please
+help us keep the gnulib list as complete as possible.

 @table @asis
 @item @code{exit}
@@ -5657,9 +5662,13 @@ Header Portability
 @cindex Portability of headers
 @cindex Header portability

-This section tries to collect knowledge about common headers, and the
-problems they cause.  By definition, this list always requires
-additions.  Please help us keeping it as complete as possible.
+This section documents some collected knowledge about common headers,
+and the problems they cause.  By definition, this list always requires
+additions.  A much more complete list is maintained by the Gnulib
+project (@pxref{Gnulib}), covering @ref{Header File Substitutes, ,
+Posix Headers, gnulib, GNU gnulib} and @ref{Glibc Header File
+Substitutes, , Glibc Headers, gnulib, GNU gnulib}.  Please help us keep
+the gnulib list as complete as possible.

 @table @asis

-- 
1.7.2.2




reply via email to

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