Re: no TABs in .texi files

[Ralf Wildenhues]

Hi Paul,

Thanks for the review!

* Paul Eggert wrote on Fri, Mar 24, 2006 at 10:27:59PM CET:
> Ralf Wildenhues <address@hidden> writes:
> 
> > +# Do not use TABs in .texi files.

> Hmm, come to think of it, the Texinfo manual says it's OK to use tabs
> in verbatim modes, and I use that in some of my manuals (e.g.,
> diffutils, since the diffutils output uses tabs).  Can you fix the
> rule to not complain about tabs in that case?

Sure.

> This would mean we could avoid the need to worry about the
> autoconf.texi change you proposed.

No, I don't think so: that's an address@hidden', not a address@hidden'.
And frankly, it simply does not look the way I believe it was
intended to look (in the DVI output).

> Also, shouldn't that look for files that end in either .texi or
> .texinfo or .txi (Bison uses .texinfo, and Texinfo uses .txi)?

Oh, I did not know that.

> Also, why just look in doc?  Can't we use CVS_LIST_EXCEPT to find all
> the texinfo files checked in under CVS?  Many packages put texinfo
> files elsewhere (e.g., Emacs, Gnus, libc).

Updated patch below, which hopefully has all issues fixed.  I did not
understand CVS_LIST_EXCEPT before (nor have I ever used or known cvsu
before now).  OK to apply?

FWIW, there are more Makefile.maint related patches coming up.

Cheers,
Ralf

        * Makefile.maint (sc_texi_notab): New check: do not use TABs
        in texinfo files.
        (syntax-check-rules): Update.
        * doc/autoconf.texi (Configuration Headers): Conform to it.

Index: Makefile.maint
===================================================================
RCS file: /cvsroot/autoconf/autoconf/Makefile.maint,v
retrieving revision 1.33
diff -u -r1.33 Makefile.maint
--- Makefile.maint      6 Jan 2006 00:02:26 -0000       1.33
+++ Makefile.maint      28 Mar 2006 18:05:24 -0000
@@ -103,7 +103,8 @@
   sc_system_h_headers \
   sc_tight_scope \
   sc_trailing_space \
-  sc_unmarked_diagnostics
+  sc_unmarked_diagnostics \
+  sc_texi_notab
 
 syntax-check: $(syntax-check-rules)
 #      @grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'         \
@@ -166,13 +167,21 @@
            exit 1; } || :
 
 sc_obsolete_symbols:
-       @grep -nE '\<(HAVE_''FCNTL_H)\>'                                        
\
+       @grep -nE '\<(HAVE_''FCNTL_H)\>'                                \
             $$($(CVS_LIST_EXCEPT)) &&                                  \
          { echo '$(ME): do not use HAVE_''FCNTL_H'                     \
                1>&2; exit 1; } || :
 
 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 
+# Do not use TABs in .texi files, except in verbatim environments.
+sc_texi_notab:
+       @sed '/address@hidden/,/address@hidden verbatim/d' /dev/null            
        \
+           $$($(CVS_LIST_EXCEPT) | grep -E '\.(texi|txi|texinfo)$$' )  \
+         | grep '[     ]' &&                                           \
+         { echo '$(ME): Do not use TABs in texinfo files outside of @verbatim' 
\
+               1>&2; exit 1; } || :
+
 # Each nonempty line must start with a year number, or a TAB.
 sc_changelog:
        @grep -n '^[^12 ]' $$(find . -maxdepth 2 -name ChangeLog) &&    \
Index: doc/autoconf.texi
===================================================================
RCS file: /cvsroot/autoconf/autoconf/doc/autoconf.texi,v
retrieving revision 1.971
diff -u -r1.971 autoconf.texi
--- doc/autoconf.texi   21 Mar 2006 21:51:07 -0000      1.971
+++ doc/autoconf.texi   28 Mar 2006 17:48:15 -0000
@@ -2757,7 +2757,7 @@
 
 @example
 AC_CONFIG_COMMANDS_PRE(
-       [m4_ifndef([AH_HEADER], [AC_CONFIG_HEADERS([config.h])])])
+        [m4_ifndef([AH_HEADER], [AC_CONFIG_HEADERS([config.h])])])
 @end example
 
 @end defmac