[PATCH 1/6] man.7: srcfix

[PATCH 1/6] man.7: srcfix

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 5718 bytes --]

Clean up in preparation for "MR sed".

From 219257753d7650332b7256653fcf80591da31887 Mon Sep 17 00:00:00 2001
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: linux-man@vger.kernel.org
Date: Fri, 28 Jul 2023 12:17:44 -0500
Subject: [PATCH 1/6] man.7: srcfix
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Drop spurious uses of *roff `\&` escape sequence.

Quoting groff_man_style(7):

    \&  Dummy character.  Insert at the beginning of an input line to
        prevent a dot or apostrophe from being interpreted as beginning
        a roff control line.  Append to an end‐of‐sentence punctuation
        sequence to keep it from being recognized as such.

Neither case applies to the uses in this page.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
---
 man7/man.7 | 70 +++++++++++++++++++++++++++---------------------------
 1 file changed, 35 insertions(+), 35 deletions(-)

diff --git a/man7/man.7 b/man7/man.7
index cf83292fa..258ce25da 100644
--- a/man7/man.7
+++ b/man7/man.7
@@ -60,7 +60,7 @@ .SS Title line
 that is, lines that start with \fB.\e"\fP) should be
 .PP
 .RS
-.B \&.TH
+.B .TH
 .I "title section date source manual"
 .RE
 .PP
@@ -76,12 +76,12 @@ .SS Title line
 command.
 .SS Sections
 Sections are started with
-.B \&.SH
+.B .SH
 followed by the heading name.
 .\" The following doesn't seem to be required (see Debian bug 411303),
 .\" If the name contains spaces and appears
 .\" on the same line as
-.\" .BR \&.SH ,
+.\" .BR .SH ,
 .\" then place the heading in double quotes.
 .PP
 The only mandatory heading is NAME, which should be the first section and
@@ -111,37 +111,37 @@ .SS Sections
 .SS Fonts
 The commands to select the type face are:
 .TP 4
-.B \&.B
+.B .B
 Bold
 .TP
-.B \&.BI
+.B .BI
 Bold alternating with italics
 (especially useful for function specifications)
 .TP
-.B \&.BR
+.B .BR
 Bold alternating with Roman
 (especially useful for referring to other
 manual pages)
 .TP
-.B \&.I
+.B .I
 Italics
 .TP
-.B \&.IB
+.B .IB
 Italics alternating with bold
 .TP
-.B \&.IR
+.B .IR
 Italics alternating with Roman
 .TP
-.B \&.RB
+.B .RB
 Roman alternating with bold
 .TP
-.B \&.RI
+.B .RI
 Roman alternating with italics
 .TP
-.B \&.SB
+.B .SB
 Small alternating with bold
 .TP
-.B \&.SM
+.B .SM
 Small (useful for acronyms)
 .PP
 Traditionally, each command can have up to six arguments, but the GNU
@@ -152,7 +152,7 @@ .SS Fonts
 For the macros that produce alternating type faces,
 the arguments will be printed next to each other without
 intervening spaces, so that the
-.B \&.BR
+.B .BR
 command can be used to specify a word in bold followed by a mark of
 punctuation in Roman.
 If no arguments are given, the command is applied to the following line
@@ -178,21 +178,21 @@ .SS Other macros and strings
 The other key macro definitions are:
 .SS Normal paragraphs
 .TP 9m
-.B \&.LP
+.B .LP
 Same as
-.B \&.PP
+.B .PP
 (begin a new paragraph).
 .TP
-.B \&.P
+.B .P
 Same as
-.B \&.PP
+.B .PP
 (begin a new paragraph).
 .TP
-.B \&.PP
+.B .PP
 Begin a new paragraph and reset prevailing indent.
 .SS Relative margin indent
 .TP 9m
-.BI \&.RS " i"
+.BI .RS " i"
 Start relative margin indent: moves the left margin
 .I i
 to the right (if
@@ -201,19 +201,19 @@ .SS Relative margin indent
 A new prevailing indent is set to 0.5 inches.
 As a result, all following paragraph(s) will be
 indented until the corresponding
-.BR \&.RE .
+.BR .RE .
 .TP
-.B \&.RE
+.B .RE
 End relative margin indent and
 restores the previous value of the prevailing indent.
 .SS Indented paragraph macros
 .TP 9m
-.BI \&.HP " i"
+.BI .HP " i"
 Begin paragraph with a hanging indent
 (the first line of the paragraph is at the left margin of
 normal paragraphs, and the rest of the paragraph's lines are indented).
 .TP
-.BI \&.IP " x i"
+.BI .IP " x i"
 Indented paragraph with optional hanging tag.
 If the tag
 .I x
@@ -224,7 +224,7 @@ .SS Indented paragraph macros
 is provided, it is hung at the left margin
 before the following indented paragraph
 (this is just like
-.B \&.TP
+.B .TP
 except the tag is included with the command instead of being on the
 following line).
 If the tag is too long, the text after the tag will be moved down to the
@@ -234,25 +234,25 @@ .SS Indented paragraph macros
 a period as the tag;
 this simplifies translation to other formats.
 .TP
-.BI \&.TP " i"
+.BI .TP " i"
 Begin paragraph with hanging tag.
 The tag is given on the next line, but
 its results are like those of the
-.B \&.IP
+.B .IP
 command.
 .SS Hypertext link macros
 .TP
-.BI \&.UR " url"
+.BI .UR " url"
 Insert a hypertext link to the URI (URL)
 .IR url ,
 with all text up to the following
-.B \&.UE
+.B .UE
 macro as the link text.
 .TP
-.B \&.UE \c
+.B .UE \c
 .RI [ trailer ]
 Terminate the link text of the preceding
-.B \&.UR
+.B .UR
 macro, with the optional
 .I trailer
 (if present, usually a closing parenthesis and/or end-of-sentence
@@ -270,20 +270,20 @@ .SS Hypertext link macros
 Heirloom Doctools Troff since 160217 (2016-02-17).
 .SS Miscellaneous macros
 .TP 9m
-.B \&.DT
+.B .DT
 Reset tabs to default tab values (every 0.5 inches);
 does not cause a break.
 .TP
-.BI \&.PD " d"
+.BI .PD " d"
 Set inter-paragraph vertical distance to d
 (if omitted, d=0.4v);
 does not cause a break.
 .TP
-.BI \&.SS " t"
+.BI .SS " t"
 Subheading
 .I t
 (like
-.BR \&.SH ,
+.BR .SH ,
 but used for a subsection inside a section).
 .SS Predefined strings
 The
-- 
2.30.2


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 1/6] man.7: srcfix

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 6793 bytes --]

Hi Branden,

On 2023-07-28 19:57, G. Branden Robinson wrote:
> Clean up in preparation for "MR sed".

Moved this into the commit message.

<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/?id=47b6b10ec8a61dade7f50d6ec2a2ff7001fb19af>

> 
> From 219257753d7650332b7256653fcf80591da31887 Mon Sep 17 00:00:00 2001
> From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
> To: linux-man@vger.kernel.org
> Date: Fri, 28 Jul 2023 12:17:44 -0500
> Subject: [PATCH 1/6] man.7: srcfix
> MIME-Version: 1.0
> Content-Type: text/plain; charset=UTF-8
> Content-Transfer-Encoding: 8bit

I wonder why all this appears in your email body.  How did you generate
it?  I bet not with git-format-patch(1), or that you modified it manually?
When I apply the patch with git am, all that ends up in the commit message
(try yourself).

Anyway, I've applied it.  Thanks!

Cheers,
Alex

> 
> Drop spurious uses of *roff `\&` escape sequence.
> 
> Quoting groff_man_style(7):
> 
>     \&  Dummy character.  Insert at the beginning of an input line to
>         prevent a dot or apostrophe from being interpreted as beginning
>         a roff control line.  Append to an end‐of‐sentence punctuation
>         sequence to keep it from being recognized as such.
> 
> Neither case applies to the uses in this page.
> 
> Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
> ---
>  man7/man.7 | 70 +++++++++++++++++++++++++++---------------------------
>  1 file changed, 35 insertions(+), 35 deletions(-)
> 
> diff --git a/man7/man.7 b/man7/man.7
> index cf83292fa..258ce25da 100644
> --- a/man7/man.7
> +++ b/man7/man.7
> @@ -60,7 +60,7 @@ .SS Title line
>  that is, lines that start with \fB.\e"\fP) should be
>  .PP
>  .RS
> -.B \&.TH
> +.B .TH
>  .I "title section date source manual"
>  .RE
>  .PP
> @@ -76,12 +76,12 @@ .SS Title line
>  command.
>  .SS Sections
>  Sections are started with
> -.B \&.SH
> +.B .SH
>  followed by the heading name.
>  .\" The following doesn't seem to be required (see Debian bug 411303),
>  .\" If the name contains spaces and appears
>  .\" on the same line as
> -.\" .BR \&.SH ,
> +.\" .BR .SH ,
>  .\" then place the heading in double quotes.
>  .PP
>  The only mandatory heading is NAME, which should be the first section and
> @@ -111,37 +111,37 @@ .SS Sections
>  .SS Fonts
>  The commands to select the type face are:
>  .TP 4
> -.B \&.B
> +.B .B
>  Bold
>  .TP
> -.B \&.BI
> +.B .BI
>  Bold alternating with italics
>  (especially useful for function specifications)
>  .TP
> -.B \&.BR
> +.B .BR
>  Bold alternating with Roman
>  (especially useful for referring to other
>  manual pages)
>  .TP
> -.B \&.I
> +.B .I
>  Italics
>  .TP
> -.B \&.IB
> +.B .IB
>  Italics alternating with bold
>  .TP
> -.B \&.IR
> +.B .IR
>  Italics alternating with Roman
>  .TP
> -.B \&.RB
> +.B .RB
>  Roman alternating with bold
>  .TP
> -.B \&.RI
> +.B .RI
>  Roman alternating with italics
>  .TP
> -.B \&.SB
> +.B .SB
>  Small alternating with bold
>  .TP
> -.B \&.SM
> +.B .SM
>  Small (useful for acronyms)
>  .PP
>  Traditionally, each command can have up to six arguments, but the GNU
> @@ -152,7 +152,7 @@ .SS Fonts
>  For the macros that produce alternating type faces,
>  the arguments will be printed next to each other without
>  intervening spaces, so that the
> -.B \&.BR
> +.B .BR
>  command can be used to specify a word in bold followed by a mark of
>  punctuation in Roman.
>  If no arguments are given, the command is applied to the following line
> @@ -178,21 +178,21 @@ .SS Other macros and strings
>  The other key macro definitions are:
>  .SS Normal paragraphs
>  .TP 9m
> -.B \&.LP
> +.B .LP
>  Same as
> -.B \&.PP
> +.B .PP
>  (begin a new paragraph).
>  .TP
> -.B \&.P
> +.B .P
>  Same as
> -.B \&.PP
> +.B .PP
>  (begin a new paragraph).
>  .TP
> -.B \&.PP
> +.B .PP
>  Begin a new paragraph and reset prevailing indent.
>  .SS Relative margin indent
>  .TP 9m
> -.BI \&.RS " i"
> +.BI .RS " i"
>  Start relative margin indent: moves the left margin
>  .I i
>  to the right (if
> @@ -201,19 +201,19 @@ .SS Relative margin indent
>  A new prevailing indent is set to 0.5 inches.
>  As a result, all following paragraph(s) will be
>  indented until the corresponding
> -.BR \&.RE .
> +.BR .RE .
>  .TP
> -.B \&.RE
> +.B .RE
>  End relative margin indent and
>  restores the previous value of the prevailing indent.
>  .SS Indented paragraph macros
>  .TP 9m
> -.BI \&.HP " i"
> +.BI .HP " i"
>  Begin paragraph with a hanging indent
>  (the first line of the paragraph is at the left margin of
>  normal paragraphs, and the rest of the paragraph's lines are indented).
>  .TP
> -.BI \&.IP " x i"
> +.BI .IP " x i"
>  Indented paragraph with optional hanging tag.
>  If the tag
>  .I x
> @@ -224,7 +224,7 @@ .SS Indented paragraph macros
>  is provided, it is hung at the left margin
>  before the following indented paragraph
>  (this is just like
> -.B \&.TP
> +.B .TP
>  except the tag is included with the command instead of being on the
>  following line).
>  If the tag is too long, the text after the tag will be moved down to the
> @@ -234,25 +234,25 @@ .SS Indented paragraph macros
>  a period as the tag;
>  this simplifies translation to other formats.
>  .TP
> -.BI \&.TP " i"
> +.BI .TP " i"
>  Begin paragraph with hanging tag.
>  The tag is given on the next line, but
>  its results are like those of the
> -.B \&.IP
> +.B .IP
>  command.
>  .SS Hypertext link macros
>  .TP
> -.BI \&.UR " url"
> +.BI .UR " url"
>  Insert a hypertext link to the URI (URL)
>  .IR url ,
>  with all text up to the following
> -.B \&.UE
> +.B .UE
>  macro as the link text.
>  .TP
> -.B \&.UE \c
> +.B .UE \c
>  .RI [ trailer ]
>  Terminate the link text of the preceding
> -.B \&.UR
> +.B .UR
>  macro, with the optional
>  .I trailer
>  (if present, usually a closing parenthesis and/or end-of-sentence
> @@ -270,20 +270,20 @@ .SS Hypertext link macros
>  Heirloom Doctools Troff since 160217 (2016-02-17).
>  .SS Miscellaneous macros
>  .TP 9m
> -.B \&.DT
> +.B .DT
>  Reset tabs to default tab values (every 0.5 inches);
>  does not cause a break.
>  .TP
> -.BI \&.PD " d"
> +.BI .PD " d"
>  Set inter-paragraph vertical distance to d
>  (if omitted, d=0.4v);
>  does not cause a break.
>  .TP
> -.BI \&.SS " t"
> +.BI .SS " t"
>  Subheading
>  .I t
>  (like
> -.BR \&.SH ,
> +.BR .SH ,
>  but used for a subsection inside a section).
>  .SS Predefined strings
>  The

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 1/6] man.7: srcfix

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 686 bytes --]

Hi Alex,

At 2023-07-28T22:56:10+0200, Alejandro Colomar wrote:
> On 2023-07-28 19:57, G. Branden Robinson wrote:
> > Clean up in preparation for "MR sed".
> 
> Moved this into the commit message.

Thanks!

[...]
> I wonder why all this appears in your email body.  How did you
> generate it?  I bet not with git-format-patch(1), or that you modified
> it manually?

The latter.  It had been so long since I had submitted a series of
patches to this list that I forgot that I had a shell script to help me
with it.  I used it for v2 of the two remaining patches, so if those
are well-formed, all I have to do in the future is remember my script.

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 1/6] man.7: srcfix

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 1695 bytes --]

Hi Branden,

On 2023-07-29 11:11, G. Branden Robinson wrote:
> Hi Alex,
> 
> At 2023-07-28T22:56:10+0200, Alejandro Colomar wrote:
>> On 2023-07-28 19:57, G. Branden Robinson wrote:
>>> Clean up in preparation for "MR sed".
>>
>> Moved this into the commit message.
> 
> Thanks!
> 
> [...]
>> I wonder why all this appears in your email body.  How did you
>> generate it?  I bet not with git-format-patch(1), or that you modified
>> it manually?
> 
> The latter.  It had been so long since I had submitted a series of
> patches to this list that I forgot that I had a shell script to help me
> with it.  I used it for v2 of the two remaining patches, so if those
> are well-formed, all I have to do in the future is remember my script.

I wonder why you need a script.  I usually do the following:

$ git format-patch -o patches/ master..HEAD --cover-letter -v1 \
	--cc linux-man@vger.kernel.org --to mtk.manpages@gmail.com;
$ vi ./patches/v1-0000*;  # edit the cover letter
$ git send-email ./patches/v1-*;

which has grown finger memory so much that a script would
over-complicate it.

(I have a global gitignore for ./patches/; see:)

$ sed -n '/^\[core]/,/^$/p' .gitconfig
[core]
	editor = vim
	excludesFile = ~/.config/git/gitignore

$ cat .config/git/gitignore 
# vim(1) tmp files
*.swp
*.swo

# Store patches here:
/patches/


And BTW, for -v2 and subsequent revisions, --range-diff is very
interesting in git-format-patch(1).  Other times, though, it's very
confusing, and --interdiff is more appropriate.


Cheers,
Alex


-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]