GNU bug report logs - #21845
sed docs bug: No documentation of which commands must be terminated by newlines

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 21845 in the body.
You can then email your comments to 21845 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: Ori Avtalion <ori <at> avtalion.name>
To: bug-sed <at> gnu.org
Subject: sed docs bug: No documentation of which commands must be terminated
 by newlines
Date: Fri, 6 Nov 2015 17:44:04 +0200

This report is based on the docs for 4.2.2

Section 3 says:
> Some commands, due to their syntax, cannot be followed by semicolons
> working as command separators and thus should be terminated with
> newlines or be placed at the end of a script or script-file.

I can find no mention of which commands this applies to.
This limitation should be mentioned next to each such command.

I'm specifically thinking of:
 * 'r filename'
 * 'R filename'
 * 'w filename'
 * 'W file-name'

All of these commands use read_filename() in compile.c, which reads a
filename until the end of the line/file.
If I have missed any commands, these should also be documented.

Related to this, a few other small issues:
* The documentation for 'W' uses 'file-name' instead of 'filename'. It
should be 'filename'.
* The documentation for 'w filename' reference a 'file-name' in their
description. It should be 'filename'.

Thanks for maintaining sed!

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Ori Avtalion <ori <at> avtalion.name>
Cc: 21845 <at> debbugs.gnu.org
Subject: Re: bug#21845: sed docs bug: No documentation of which commands must
 be terminated by newlines
Date: Wed, 25 Jan 2017 03:51:51 +0000

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

Hello Ori,

Sorry for the delayed response.

On Fri, Nov 06, 2015 at 05:44:04PM +0200, Ori Avtalion wrote:
>Some commands, due to their syntax, cannot be followed by semicolons
>[...]
>I can find no mention of which commands this applies to.
>This limitation should be mentioned next to each such command.

Thank you for mentioning this. Indeed an important piece of information.

I'm considering adding a new section about this.
Draft attached, comments welcomed.

>The documentation uses 'file-name' instead of 'filename'.

Fixed as well.

regards,
- assaf

[0001-doc-new-multiple-commands-syntax-section.patch (text/x-diff, attachment)]

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

From: Jim Meyering <jim <at> meyering.net>
To: Assaf Gordon <assafgordon <at> gmail.com>
Cc: Ori Avtalion <ori <at> avtalion.name>, 21845 <at> debbugs.gnu.org
Subject: Re: bug#21845: sed docs bug: No documentation of which commands must
 be terminated by newlines
Date: Tue, 24 Jan 2017 20:34:37 -0800

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

On Tue, Jan 24, 2017 at 7:51 PM, Assaf Gordon <assafgordon <at> gmail.com> wrote:
> Hello Ori,
>
> Sorry for the delayed response.
>
> On Fri, Nov 06, 2015 at 05:44:04PM +0200, Ori Avtalion wrote:
>>
>> Some commands, due to their syntax, cannot be followed by semicolons
>> [...]
>> I can find no mention of which commands this applies to.
>> This limitation should be mentioned next to each such command.
>
>
> Thank you for mentioning this. Indeed an important piece of information.
>
> I'm considering adding a new section about this.
> Draft attached, comments welcomed.

Thank you for that addition.
I did a quick once-over and suggest these changes:

[sed-0001-doc-new-multiple-commands-syntax-section-touch-up.patch (text/x-patch, attachment)]

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Jim Meyering <jim <at> meyering.net>
Cc: Ori Avtalion <ori <at> avtalion.name>, 21845 <at> debbugs.gnu.org
Subject: Re: bug#21845: sed docs bug: No documentation of which commands must
 be terminated by newlines
Date: Fri, 27 Jan 2017 02:54:12 +0000

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

Hello Jim,

On Tue, Jan 24, 2017 at 08:34:37PM -0800, Jim Meyering wrote:
>On Tue, Jan 24, 2017 at 7:51 PM, Assaf Gordon <assafgordon <at> gmail.com> wrote:
>> On Fri, Nov 06, 2015 at 05:44:04PM +0200, Ori Avtalion wrote:
>>>
>>> Some commands, due to their syntax, cannot be followed by semicolons
>>
>> Thank you for mentioning this. Indeed an important piece of information.
>>
>> I'm considering adding a new section about this.
>
> I did a quick once-over and suggest these changes:

Thanks for the review.
I've incorporated your changes, but also added two small items
(about 'e' and 's///[ew]') - so sending again before pushing anything.

comments again welcomed,
- assaf

[0001-doc-new-multiple-commands-syntax-section.patch (text/x-diff, attachment)]

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

From: Jim Meyering <jim <at> meyering.net>
To: Assaf Gordon <assafgordon <at> gmail.com>
Cc: Ori Avtalion <ori <at> avtalion.name>, 21845 <at> debbugs.gnu.org
Subject: Re: bug#21845: sed docs bug: No documentation of which commands must
 be terminated by newlines
Date: Thu, 26 Jan 2017 21:29:55 -0800

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

On Thu, Jan 26, 2017 at 6:54 PM, Assaf Gordon <assafgordon <at> gmail.com> wrote:
> Hello Jim,
>
> On Tue, Jan 24, 2017 at 08:34:37PM -0800, Jim Meyering wrote:
>>
>> On Tue, Jan 24, 2017 at 7:51 PM, Assaf Gordon <assafgordon <at> gmail.com>
>> wrote:
>>>
>>> On Fri, Nov 06, 2015 at 05:44:04PM +0200, Ori Avtalion wrote:
>>>>
>>>>
>>>> Some commands, due to their syntax, cannot be followed by semicolons
>>>
>>>
>>> Thank you for mentioning this. Indeed an important piece of information.
>>>
>>> I'm considering adding a new section about this.
>>
>>
>> I did a quick once-over and suggest these changes:
>
>
> Thanks for the review.
> I've incorporated your changes, but also added two small items
> (about 'e' and 's///[ew]') - so sending again before pushing anything.

Thanks. That looks fine. One fix: s/ro/or/ and a suggested wording change:

[sed-0001-doc-new-multiple-commands-syntax-section-touch-up2.patch (application/octet-stream, attachment)]

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Jim Meyering <jim <at> meyering.net>
Cc: Ori Avtalion <ori <at> avtalion.name>, 21845 <at> debbugs.gnu.org
Subject: Re: bug#21845: sed docs bug: No documentation of which commands must
 be terminated by newlines
Date: Sat, 28 Jan 2017 20:26:23 +0000

tags 21845 fixed
close 21845
stop


On Thu, Jan 26, 2017 at 09:29:55PM -0800, Jim Meyering wrote:
>Thanks. That looks fine. One fix: s/ro/or/ and a suggested wording change:

Thanks for the quick review.

Pushed here:
 http://git.savannah.gnu.org/cgit/sed.git/commit/?id=cca9795a716e558c21

regards,
- assaf

Previous Next

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