bug-coreutils
[Top][All Lists]
Advanced

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

Re: various documentation fixes for coreutils (notably, tr examples)


From: Jim Meyering
Subject: Re: various documentation fixes for coreutils (notably, tr examples)
Date: Fri, 02 Jul 2004 18:34:30 +0200

Paul Eggert <address@hidden> wrote:
> Here's a bunch of minor documentation patches for coreutils, notably
> in the tr examples.  These patches assume the "filesystem" -> "file
> system" patch I submitted earlier today.  I don't think any of them
> are controversial, but if you'd prefer me to split some of them out
> please let me know.
>
> 2004-06-30  Paul Eggert  <address@hidden>

They're fine the way they are.
I've applied those changes, along with the following.
If you think of more ways to automate enforcement
of such conventions, please let me know.

2004-07-02  Jim Meyering  <address@hidden>

        * Makefile.am (check-texinfo): Disallow `filename' in .texi files.
        Spell it like `file name' instead, to be consistent.
        Fail if a @footnote directive follows non-punctuation.
        Fail upon use of @url.  Use @uref instead.

Index: Makefile.am
===================================================================
RCS file: /fetish/cu/doc/Makefile.am,v
retrieving revision 1.29
retrieving revision 1.32
diff -u -p -r1.29 -r1.32
--- Makefile.am 9 May 2004 19:43:23 -0000       1.29
+++ Makefile.am 2 Jul 2004 15:18:43 -0000       1.32
@@ -32,8 +32,12 @@ check-texinfo:
        grep timezone $(srcdir)/*.texi && fail=1; \
        grep -w IO $(srcdir)/*.texi && fail=1; \
        grep non-zero $(srcdir)/*.texi && fail=1; \
+       grep '@url{' $(srcdir)/*.texi && fail=1; \
        grep -w NUL $(srcdir)/*.texi && fail=1; \
        grep '\$$@"' $(srcdir)/*.texi && fail=1; \
+       grep -n '[^[:punct:address@hidden' $(srcdir)/*.texi && fail=1; \
+       grep -n filename $(srcdir)/*.texi|grep -vE 'setfilename|{filename}' \
+         && fail=1; \
        $(PERL) -e 1 2> /dev/null && { $(PERL) -ne \
          '/\bPOSIX\b/ && !/address@hidden/ && !/^\* / || /{posix}/ and 
print,exit 1' \
          $(srcdir)/*.texi 2> /dev/null || fail=1; }; \




reply via email to

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