GNU bug report logs - #13371
removing @acronym from manual

Previous Next

Package: coreutils;

Reported by: karl <at> freefriends.org (Karl Berry)

Date: Sun, 6 Jan 2013 23:11:01 UTC

Severity: normal

Tags: fixed

Done: Assaf Gordon <assafgordon <at> gmail.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: karl <at> freefriends.org (Karl Berry)
To: eliz <at> gnu.org
Cc: 13371 <at> debbugs.gnu.org
Subject: bug#13371: removing @acronym from manual
Date: Sun, 6 Jan 2013 23:09:53 GMT
    the latest Texinfo documentation (from the 4.13.93 pretest) says
    nothing about that

On the contrary, I added (brief) text to both the acronym and Smallcaps
nodes giving caveats about using @acronym and @sc quite a while ago.
It's been in all the pretests.  I've retweaked that text again just now,
though, so I'm glad you mentioned it.

Anyway, avoiding them is not official requirement, not at all.  Not even
an official recommendation.  I just came to the conclusion when people
asked my advice some years ago -- I observed that whenever a manual
tries to use @acronym or @sc for normal all-caps abbreviations, such as
"GNU", in practice the commands are not used consistently (as we have
just seen in the coreutils case).

Since there's no special benefit to using @acronym{GNU} or @sc{gnu} over
just plain "GNU", it's merely about typographic preferences, my
suggestion was that it was better to avoid the whole issue, simplify the
source, and go with "GNU".

Nevertheless, if a GNU manual wants to use them, that is fine by me.

k




This bug report was last modified 6 years and 215 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.