[Top][All Lists]

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

Re: automake.texi and @acronym

From: Ralf Wildenhues
Subject: Re: automake.texi and @acronym
Date: Sun, 28 Mar 2010 17:42:24 +0200
User-agent: Mutt/1.5.20 (2009-10-28)

* Karl Berry wrote on Fri, Mar 19, 2010 at 10:42:14PM CET:
>     Is the intention that even the address@hidden cases should be
>     replaced?  Then what purpose is the @acronym keyword for?
> I wrote about that earlier.  Minor typographic change which is rarely
> used in GNU manuals.  De facto standard is not to use it.  Which is
> also simpler in the source.  To try to use it consistently/everywhere
> leads into deep waters (I have to do this in my TeX editorial life,
> and it is exceedingly time-consuming).  And it can't be used in node
> names in any case, so there will always be inconsistencies.  Do we
> have to keep going with this?

I think we've waited long enough for somebody to speak up, and the
current discussion didn't seem to turn the shed into a nuclear power
plant, so here we go.  Posting patches to the individual lists only.

I'll be pushing this to automake git soonish.


    Remove uses of @acronym and @sc.
    * doc/automake.texi (Public Macros, Limitations on File Names):
    Remove all usage of @acronym and @sc in the manual.
    Suggested by Karl Berry.

diff --git a/doc/automake.texi b/doc/automake.texi
index 7df95ff..19e0224 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -17,7 +17,7 @@
-This manual is for @acronym{GNU} Automake (version @value{VERSION},
+This manual is for GNU Automake (version @value{VERSION},
 @value{UPDATED}), a program that creates GNU standards-compliant
 Makefiles from template files.
@@ -27,11 +27,11 @@ Inc.
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the @acronym{GNU} Free Documentation License,
+under the terms of the GNU Free Documentation License,
 Version 1.3 or any later version published by the Free Software
 Foundation; with no Invariant Sections, with no Front-Cover texts,
 and with no Back-Cover Texts.  A copy of the license is included in the
-section entitled address@hidden Free Documentation License.''
+section entitled ``GNU Free Documentation License.''
 @end quotation
 @end copying
@@ -3841,7 +3841,7 @@ output variable @code{lispdir} to the full path to Emacs' 
 Note that this test assumes the @command{emacs} found to be a version
-that supports Emacs Lisp (such as @sc{gnu} Emacs or XEmacs).  Other
+that supports Emacs Lisp (such as GNU Emacs or XEmacs).  Other
 emacsen can cause this test to hang (some, like old versions of
 MicroEmacs, start up in interactive mode, requiring @kbd{C-x C-c} to
 exit, which is hardly obvious for a non-emacs user).  In most cases,
@@ -10695,20 +10695,20 @@ names, and reserve @samp{/} as a directory separator. 
 Also, they
 require that file names are properly encoded for the user's locale.
 Automake is subject to these limits.
-Portable packages should limit themselves to @acronym{POSIX} file
-names.  These can contain @acronym{ASCII} letters and digits,
+Portable packages should limit themselves to POSIX file
+names.  These can contain ASCII letters and digits,
 @samp{_}, @samp{.}, and @samp{-}.  File names consist of components
 separated by @samp{/}.  File name components cannot begin with
 Portable POSIX file names cannot contain components that exceed a
 14-byte limit, but nowadays it's normally safe to assume the
-more-generous @acronym{XOPEN} limit of 255 bytes.  @acronym{POSIX}
-limits file names to 255 bytes (@acronym{XOPEN} allows 1023 bytes),
+more-generous XOPEN limit of 255 bytes.  POSIX
+limits file names to 255 bytes (XOPEN allows 1023 bytes),
 but you may want to limit a source tarball to file names of 99 bytes
 to avoid interoperability problems with old versions of @command{tar}.
-If you depart from these rules (e.g., by using address@hidden
+If you depart from these rules (e.g., by using non-ASCII
 characters in file names, or by using lengthy file names), your
 installers may have problems for reasons unrelated to Automake.
 However, if this does not concern you, you should know about the
@@ -10738,12 +10738,12 @@ For example, the full name of the directory 
containing the source
 files should not contain these characters.
 Source and installation file names like @file{main.c} are limited even
-further: they should conform to the @acronym{POSIX}/@acronym{XOPEN}
+further: they should conform to the POSIX/XOPEN
 rules described above.  In addition, if you plan to port to
address@hidden environments, you should avoid file names that
+non-POSIX environments, you should avoid file names that
 differ only in case (e.g., @file{makefile} and @file{Makefile}).
 Nowadays it is no longer worth worrying about the 8.3 limits of
address@hidden file systems.
+DOS file systems.
 @node distcleancheck
 @section Files left in build directory after distclean

reply via email to

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