GNU bug report logs - #22636
tab characters in documentation

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 22636 in the body.
You can then email your comments to 22636 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: Clint Adams <clint <at> debian.org>
To: bug-sed <at> gnu.org
Subject: tab characters in documentation
Date: Thu, 11 Feb 2016 23:22:25 +0000

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

The way @kbd{tab} is getting rendered in the Info and HTML
documentation is confusing some users, f.ex.
https://bugs.debian.org/671817

The Texinfo documentation suggests that these should be
@key{TAB} instead.

[0001-Use-key-TAB-instead-of-kbd-TAB-in-Texinfo.patch (text/x-diff, attachment)]

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Clint Adams <clint <at> debian.org>
Cc: 22636 <at> debbugs.gnu.org
Subject: Re: bug#22636: tab characters in documentation
Date: Sat, 28 Jan 2017 21:22:45 +0000

Hello Clint,

Sorry for the delayed response.

On Thu, Feb 11, 2016 at 11:22:25PM +0000, Clint Adams wrote:
>The way @kbd{tab} is getting rendered in the Info and HTML
>documentation is confusing some users, f.ex.
>https://bugs.debian.org/671817

Thanks for the report.

We can and should change this.

I'd also like to start working towards reducing the amount of upstream 
patches debian uses on gnu sed.

For sed-4.2.2 in Debian/Jessie I saw there were many patches.

I just checked 'stretch', and it seems you've picked up sed-4.3 and it 
seems there are less patches. If there's anything we can improve, please 
let us know.

Lastly, two changes since the official 4.3 (if it is included in 
stretch):

1.
sed-4.3 has a critical bug which was discovered after the release.
Please see here:
 https://bugs.gnu.org/25390
Fixed in these commits:
 http://git.savannah.gnu.org/cgit/sed.git/commit/?id=44d99bf5c98
 http://git.savannah.gnu.org/cgit/sed.git/commit/?id=0f98f0055e4

2.
I think you've added an upstream patch about cross-compiling.
We encorporated something similar in the sed's git, see here:
 https://bugs.gnu.org/25358
Fixed in this commit:
 http://git.savannah.gnu.org/cgit/sed.git/commit/?id=a0a25e3ee35f


There will be a sed-4.3.1 very soon with this buxfix,
but I can't commit to ETA.


regards,
- assaf

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Clint Adams <clint <at> debian.org>
Cc: 22636 <at> debbugs.gnu.org
Subject: Re: bug#22636: tab characters in documentation
Date: Tue, 9 Oct 2018 06:03:06 -0600

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

Hello,

> On Thu, Feb 11, 2016 at 11:22:25PM +0000, Clint Adams wrote:
>> The way @kbd{tab} is getting rendered in the Info and HTML 
>> documentation is confusing some users,

in HTML, the @kbd{tab} is rendered as <kbd>TAB</kbd>.
While the default CSS has no special rendering for <kbd>,
in our official online page it has "font-style: oblique;",
and so it is already rendered nicely:
https://www.gnu.org/software/sed/manual/sed.html#wc-_002dw

in INFO (viewed on a text terminal), indeed @key{TAB} is more noticeable
than @kbd{tab}.

I suggest the following patch (in your name) to add @key{TAB} but
also keep the existing @kbd{}.

If there are no objections I'll push this soon.

regards,
 - assaf

[0001-doc-use-key-TAB-in-texinfo.patch (text/x-patch, attachment)]

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Clint Adams <clint <at> debian.org>
Cc: 22636 <at> debbugs.gnu.org
Subject: Re: bug#22636: tab characters in documentation
Date: Fri, 12 Oct 2018 11:50:43 -0600

tags 22636 fixed
close 22636
stop

Hello,

On 09/10/18 06:03 AM, Assaf Gordon wrote:
> 
>> On Thu, Feb 11, 2016 at 11:22:25PM +0000, Clint Adams wrote:
>>> The way @kbd{tab} is getting rendered in the Info and HTML 
>>> documentation is confusing some users,
> 
> I suggest the following patch (in your name) to add @key{TAB} but
> also keep the existing @kbd{}.
> 

Pushed here:
https://git.savannah.gnu.org/cgit/sed.git/commit/?id=8e52c0aff039f0a88127ca131b060050c107b0e2


regards,
 - assaf

Previous Next

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