build+doc changes

[Jim Meyering]

automake's silent-rules options (AM_V_GEN) is slowly taking over...

I've just pushed the following four change sets, as well
as the four chroot-related ones I posted a few days ago:

      build (man/): use automake's new $(AM_V_GEN) variable
      build: make generated man/*.1 files read-only
      build: no longer list gnulib's "memchr" module as obsolete
      doc: HACKING: mention the GNU Coding Standards

>From 3299cb39ce4a91cdb5eb54e753049668d1cf7117 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Fri, 24 Apr 2009 22:23:50 +0200
Subject: [PATCH 1/4] build (man/): use automake's new $(AM_V_GEN) variable

* man/Makefile.am (.x.1, check-x-vs-1, check-programs-vs-x):
Mark with $(AM_V_GEN), so that automake-1.11 prints
"GEN $@" by default (stick with "GEN" in spite of the latter two
rules not officially generating anything -- they're just tests).
---
 man/Makefile.am |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/man/Makefile.am b/man/Makefile.am
index ec5284b..906e804 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -148,14 +148,14 @@ mapped_name = `echo $*|sed 's/^install$$/ginstall/; 
s/^test$$/[/'`
 # That is necessary to avoid failures for programs that are also shell built-in
 # functions like echo, false, printf, pwd.
 .x.1:
-       @case '$(PERL)' in                                      \
+       $(AM_V_GEN)case '$(PERL)' in                            \
          *"/missing "*)                                        \
            echo 'WARNING: cannot update man page $@ since perl is missing' \
-             'or inadequate' 1>&2 \
+             'or inadequate' 1>&2                              \
            ;;                                                  \
          *)                                                    \
            rm -f $@                                            \
-           && { echo "Updating man page $@";                   \
+           && {                                                \
                 rm -rf $t;                                     \
                 mkdir $t;                                      \
                 (cd $t && $(LN_S) ../../src/$(mapped_name) $*); \
@@ -181,7 +181,7 @@ ASSORT = LC_ALL=C sort
 # add them here manually.
 .PHONY: check-x-vs-1
 check-x-vs-1:
-       PATH=../src$(PATH_SEPARATOR)$$PATH; export PATH;                \
+       $(AM_V_GEN)PATH=../src$(PATH_SEPARATOR)$$PATH; export PATH;     \
        t=ls-files.$$$$;                                                \
        (cd $(srcdir) && ls -1 *.x) | sed 's/\.x$$//' | $(ASSORT) > $$t;\
        (echo $(dist_man1_MANS) $(NO_INSTALL_PROGS_DEFAULT)             \
@@ -195,7 +195,7 @@ all_programs =                                              
                \

 .PHONY: check-programs-vs-x
 check-programs-vs-x:
-       status=0;                                       \
+       $(AM_V_GEN)status=0;                            \
        for p in dummy `$(all_programs)`; do            \
          test $$p = dummy && continue;                 \
          test $$p = ginstall && p=install || : ;       \
--
1.6.3.1.308.g426b5


>From bb4d6359057530198f3bedb65f817549eb1bd076 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Sun, 31 May 2009 09:52:51 +0200
Subject: [PATCH 2/4] build: make generated man/*.1 files read-only

This should help people notice that they are generated.
Note: each file already has a comment to that effect from help2man.
* man/Makefile.am (.x.1): Make generated files read-only.
Also, don't redirect directly to the target, address@hidden
---
 man/Makefile.am |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/man/Makefile.am b/man/Makefile.am
index 906e804..ee16a3f 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -154,7 +154,7 @@ mapped_name = `echo $*|sed 's/^install$$/ginstall/; 
s/^test$$/[/'`
              'or inadequate' 1>&2                              \
            ;;                                                  \
          *)                                                    \
-           rm -f $@                                            \
+           rm -f $@ address@hidden                                     \
            && {                                                \
                 rm -rf $t;                                     \
                 mkdir $t;                                      \
@@ -164,8 +164,11 @@ mapped_name = `echo $*|sed 's/^install$$/ginstall/; 
s/^test$$/[/'`
                     --include=$(srcdir)/$*.x                   \
                     --output=$t/$@ $t/$*;                      \
               }                                                \
-           && sed 's|$*\.td/||g' $t/$@ > $@                    \
-           && rm -rf $t ;;                                     \
+           && sed 's|$*\.td/||g' $t/$@ > address@hidden                        
\
+           && rm -rf $t                                        \
+           && chmod -w address@hidden                                  \
+           && mv address@hidden $@                                     \
+           ;;                                                  \
        esac

 distcheck-hook: check-x-vs-1 check-programs-vs-x
--
1.6.3.1.308.g426b5


>From a550d7149e6c8b3609a20ef721f9318dfc22088f Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Sun, 31 May 2009 15:18:16 +0200
Subject: [PATCH 3/4] build: no longer list gnulib's "memchr" module as obsolete

* bootstrap.conf (obsolete_gnulib_modules): Remove memchr from
the list, now that it fixes a problem in some modern C libraries.
(gnulib_modules): Add it here.
---
 bootstrap.conf |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/bootstrap.conf b/bootstrap.conf
index d34e908..6671027 100644
--- a/bootstrap.conf
+++ b/bootstrap.conf
@@ -27,7 +27,6 @@ avoided_gnulib_modules='
 # but leave them in for now to minimize changes.
 obsolete_gnulib_modules='
   atexit
-  memchr
   memcmp
   memcpy
   memmove
@@ -141,6 +140,7 @@ gnulib_modules="
   mbsalign
   mbswidth
   memcasecmp
+  memchr
   memcmp2
   mempcpy
   memrchr
--
1.6.3.1.308.g426b5


>From 635a5b300db1b8d22c000d1adcfc10a4357e5876 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Tue, 2 Jun 2009 07:52:02 +0200
Subject: [PATCH 4/4] doc: HACKING: mention the GNU Coding Standards

* HACKING (Add documentation): Add a link to the GCS.
---
 HACKING |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/HACKING b/HACKING
index ae43e3a..d58f2d3 100644
--- a/HACKING
+++ b/HACKING
@@ -261,6 +261,9 @@ When writing prose (documentation, comments, log entries), 
use an
 active voice, not a passive one.  I.e., say "print the frobnozzle",
 not "the frobnozzle will be printed".

+Please add comments per the GNU Coding Standard:
+  http://www.gnu.org/prep/standards/html_node/Comments.html
+

 Minor syntactic preferences
 ===========================
--
1.6.3.1.308.g426b5