GNU bug report logs - #30479
[PATCH] sed.x: Some formatting corrections

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 30479 in the body.
You can then email your comments to 30479 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: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
To: bug-sed <at> gnu.org
Subject: [PATCH] sed.x: Some formatting corrections
Date: Fri, 16 Feb 2018 01:32:35 +0000

Test nr. 14: Change a two-fonts macro to an one-font macro.

236:.IR number

#####

Test nr. 19: Use a macro to change to italic font

21:permits scripted edits (such as \fIed\fP),
70:q [\fIexit-code\fR]
76:Q [\fIexit-code\fR]
317:The \fI-E\fP option switches to using extended regular expressions instead;

#####

Test nr. 23: Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options)

246:For example, ``sed -n 1~2p'' will print all the odd-numbered lines in
317:The \fI-E\fP option switches to using extended regular expressions instead;
318:the -E option has been supported for years by GNU sed, and is now

#####

  Additionally:

  separate some sentences (clauses)

  use a pronoun instead of a repeated noun.

Signed-off-by: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
---
 doc/sed.x | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

diff --git a/doc/sed.x b/doc/sed.x
index b2e0beb..eae323d 100644
--- a/doc/sed.x
+++ b/doc/sed.x
@@ -18,7 +18,8 @@ A stream editor is used to perform basic text
 transformations on an input stream
 (a file or input from a pipeline).
 While in some ways similar to an editor which
-permits scripted edits (such as \fIed\fP),
+permits scripted edits (such as
+.IR ed ),
 \*(sd works by making only one pass over the
 input(s), and is consequently more efficient.
 But it is \*(sd's ability to filter text in a pipeline
@@ -42,7 +43,7 @@ commands.
 .TP
 .RI # comment
 The comment extends until the next newline (or the end of a
-.B -e
+.B \-e
 script fragment).
 .TP
 }
@@ -67,13 +68,15 @@ Insert
 .IR text ,
 which has each embedded newline preceded by a backslash.
 .TP
-q [\fIexit-code\fR]
+q \c
+.RI [ exit-code ]
 Immediately quit the \*(sd script without processing
 any more input, except that if auto-print is not disabled
 the current pattern space will be printed.  The exit code
 argument is a GNU extension.
 .TP
-Q [\fIexit-code\fR]
+Q \c
+.RI [ exit-code ]
 Immediately quit the \*(sd script without processing
 any more input.  This is a GNU extension.
 .TP
@@ -233,9 +236,9 @@ The following address types are supported:
 .TP
 .I number
 Match only the specified line
-.IR number
+.I number
 (which increments cumulatively across files, unless the
-.B -s
+.B \-s
 option is specified on the command line).
 .TP
 .IR first ~ step
@@ -243,7 +246,7 @@ Match every
 .IR step 'th
 line starting with line
 .IR first .
-For example, ``sed -n 1~2p'' will print all the odd-numbered lines in
+For example, ``sed \-n 1~2p'' will print all the odd-numbered lines in
 the input stream, and the address 2~5 will match every fifth line,
 starting with the second.
 .I first
@@ -314,9 +317,11 @@ and similarly for
 .BR \ea ,
 .BR \et ,
 and other sequences.
-The \fI-E\fP option switches to using extended regular expressions instead;
-the -E option has been supported for years by GNU sed, and is now
-included in POSIX.
+The
+.I \-E
+option switches to using extended regular expressions instead;
+It has been supported for years by GNU sed,
+and is now included in POSIX.
 
 [SEE ALSO]
 .BR awk (1),
@@ -334,5 +339,5 @@ http://sed.sf.net/grabbag/.
 .PP
 E-mail bug reports to
 .BR bug-sed <at> gnu.org .
-Also, please include the output of ``sed --version'' in the body
+Also, please include the output of ``sed \-\-version'' in the body
 of your report if at all possible.
-- 
2.15.1

-- 
Bjarni I. Gislason

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>, 30479 <at> debbugs.gnu.org
Subject: Re: bug#30479: [PATCH] sed.x: Some formatting corrections
Date: Mon, 8 Oct 2018 19:12:47 -0600

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

Hello,

On 15/02/18 06:32 PM, Bjarni Ingi Gislason wrote:

> Test nr. 23: Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
> (\-, minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options)

Thank you for the report and the patch (and sorry for the late reply).

Attached is a patch containing a subset of your suggestions (dash to 
minus + pronoun).

These are trivial and are also small enough to push without copyright 
assignment. I'll push soon if there are no objections.


As for the font changes - what is the reason for them?
(e.g. is there some recommendation of which font should be used for 
which type of content?)


Regards,
 - assaf

[0001-doc-sed.x-some-formatting-corrections.patch (text/x-patch, attachment)]

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

From: Assaf Gordon <assafgordon <at> gmail.com>
To: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>, 30479 <at> debbugs.gnu.org
Subject: Re: bug#30479: [PATCH] sed.x: Some formatting corrections
Date: Fri, 12 Oct 2018 11:49:28 -0600

tags 30479 fixed
close 30479
stop

Hello,

On 08/10/18 07:12 PM, Assaf Gordon wrote:
> On 15/02/18 06:32 PM, Bjarni Ingi Gislason wrote:
> 
>> Test nr. 23: Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
>> (\-, minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options)
> 
> Thank you for the report and the patch (and sorry for the late reply).
> 
> Attached is a patch containing a subset of your suggestions (dash to 
> minus + pronoun).

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


> As for the font changes - what is the reason for them?
> (e.g. is there some recommendation of which font should be used for 
> which type of content?)
> 

I'm marking this as "fixed" (without changing the fonts).
If there's interest in additional changes, please reply to this thread 
and we can re-open the bug.

regards,
 - assaf

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

From: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
To: Assaf Gordon <assafgordon <at> gmail.com>
Cc: 30479 <at> debbugs.gnu.org
Subject: Re: bug#30479: [PATCH] sed.x: Some formatting corrections
Date: Fri, 12 Oct 2018 23:06:54 +0000

On Fri, Oct 12, 2018 at 11:49:28AM -0600, Assaf Gordon wrote:
> [...]
> 
> >As for the font changes - what is the reason for them?
> >(e.g. is there some recommendation of which font should be used
> >for which type of content?)
> >
> 

  The macros "IR" and "RI" have the italic corrections ('\,' and '\/').

  The two letters font macros (here 'IR') are for alternating the
fonts, and thus are used for two or more arguments.

-- 
Bjarni I. Gislason

Previous Next

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