GNU bug report logs - #16802
@w for long option names

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 16802 in the body.
You can then email your comments to 16802 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: karl <at> freefriends.org (Karl Berry)
To: bug-coreutils <at> gnu.org
Subject: @w for long option names
Date: Tue, 18 Feb 2014 23:57:29 GMT

In a couple places, coreutils.texi uses @w around (bare) long option
names.  These are the ones I noticed:

621:@item @w{@kbd{--strip-trailing-slashes}}
1268:The @w{@kbd{--target-directory}} (@option{-t}) option allows the @command{cp},
1312:operating on it.  The @w{@kbd{--strip-trailing-slashes}} option enables

I'm guess the point is to avoid line breaks at the internal hyphens
(there would/should never be line breaks at leading hyphens).  In which
case, a cleaner/more general approach would be

@allowcodebreaks false

Then there is no need for sprinkling @w throughout the source.
We added that in Texinfo 4.11, released 2007.

(It belatedly occurs to me that we should make @option, specifically,
always disallow line breaks at hyphens.)

karl

Message #8 received at 16802 <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: Karl Berry <karl <at> freefriends.org>, 16802 <at> debbugs.gnu.org
Subject: Re: bug#16802: @w for long option names
Date: Tue, 18 Feb 2014 23:20:16 -0800

[Message part 1 (text/plain, inline)]

Karl Berry wrote:
> Then there is no need for sprinkling @w throughout the source.

Something like the attached patch?  It gets rid of most @kbd instances, too.

> (It belatedly occurs to me that we should make @option, specifically,
> always disallow line breaks at hyphens.)

Yes, that sounds like a win.

[at-w.diff (text/plain, attachment)]

Message #11 received at 16802 <at> debbugs.gnu.org (full text, mbox):

From: karl <at> freefriends.org (Karl Berry)
To: eggert <at> cs.ucla.edu
Cc: 16802 <at> debbugs.gnu.org
Subject: Re: bug#16802: @w for long option names
Date: Fri, 21 Feb 2014 01:23:50 GMT

    Something like the attached patch?  

Exactly.  Thanks.

    It gets rid of most @kbd instances, too.

I don't think @kbd should ever be used with option names.
(Aside from actual examples of command lines being typed as input. :)

karl

Message #16 received at 16802-done <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: Karl Berry <karl <at> freefriends.org>
Cc: 16802-done <at> debbugs.gnu.org
Subject: Re: bug#16802: @w for long option names
Date: Thu, 20 Feb 2014 18:26:05 -0800

OK, thanks, I installed it on savannah and am marking this as done.

Previous Next

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