diff mbox series

[07/10] man: grammar fixes to some manpages

Message ID 20231026085506.94343-7-jengelh@inai.de
State Superseded
Headers show
Series [01/10] man: display number ranges with an en dash | expand

Commit Message

Jan Engelhardt Oct. 26, 2023, 8:55 a.m. UTC
English generally uses open compounds rather than closed ones;
fix the excess hyphens in words. Fix a missing dash for the
portnr option as well.

Signed-off-by: Jan Engelhardt <jengelh@inai.de>
---
 extensions/libxt_MASQUERADE.man |  2 +-
 extensions/libxt_helper.man     | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

Comments

Phil Sutter Oct. 26, 2023, 12:53 p.m. UTC | #1
On Thu, Oct 26, 2023 at 10:55:03AM +0200, Jan Engelhardt wrote:
> English generally uses open compounds rather than closed ones;
> fix the excess hyphens in words. Fix a missing dash for the
> portnr option as well.
> 
> Signed-off-by: Jan Engelhardt <jengelh@inai.de>
> ---
>  extensions/libxt_MASQUERADE.man |  2 +-
>  extensions/libxt_helper.man     | 10 +++++-----
>  2 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/extensions/libxt_MASQUERADE.man b/extensions/libxt_MASQUERADE.man
> index e2009086..7cc2bb7a 100644
> --- a/extensions/libxt_MASQUERADE.man
> +++ b/extensions/libxt_MASQUERADE.man
> @@ -15,7 +15,7 @@ any established connections are lost anyway).
>  \fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP]
>  This specifies a range of source ports to use, overriding the default
>  .B SNAT
> -source port-selection heuristics (see above).  This is only valid
> +source port-selection heuristics (see above). This is only valid

Do you miss a dash in:

"default SNAT source port selection heuristics"? I lean towards putting
dashes everywhere, but my language spoils me. ;)

Thanks, Phil
Jan Engelhardt Oct. 26, 2023, 3:10 p.m. UTC | #2
On Thursday 2023-10-26 14:53, Phil Sutter wrote:
>> diff --git a/extensions/libxt_MASQUERADE.man b/extensions/libxt_MASQUERADE.man
>> index e2009086..7cc2bb7a 100644
>> --- a/extensions/libxt_MASQUERADE.man
>> +++ b/extensions/libxt_MASQUERADE.man
>> @@ -15,7 +15,7 @@ any established connections are lost anyway).
>>  \fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP]
>>  This specifies a range of source ports to use, overriding the default
>>  .B SNAT
>> -source port-selection heuristics (see above).  This is only valid
>> +source port-selection heuristics (see above). This is only valid
>
>Do you miss a dash in:
>
>"default SNAT source port selection heuristics"? I lean towards putting
>dashes everywhere, but my language spoils me. ;)

Third time's the charm, hopefully?




The following changes since commit ccecb1b90ae2af6e963d27ada8d5fd69d40231c4:

  extensions: string: Adjust description of --to to recent kernel changes (2023-10-25 17:23:57 +0200)

are available in the Git repository at:

  https://github.com/jengelh/iptables 

for you to fetch changes up to 0342b75582b98a175ee804fa636161e91be1d696:

  man: reveal rateest's combination categories (2023-10-26 15:56:24 +0200)

----------------------------------------------------------------
Jan Engelhardt (7):
      man: display number ranges with an en dash
      man: encode minushyphen the way groff/man requires it
      man: encode emdash the way groff/man requires it
      man: encode hyphens the way groff/man requires it
      man: consistent casing of "IPv[46]"
      man: grammar fixes to some manpages
      man: use native bullet point markup

Phil Sutter (2):
      man: use .TP for lists in xt_osf man page
      man: reveal rateest's combination categories

 extensions/libip6t_DNPT.man     |  2 +-
 extensions/libip6t_REJECT.man   |  7 ++++---
 extensions/libip6t_SNPT.man     |  2 +-
 extensions/libipt_REJECT.man    |  7 ++++---
 extensions/libipt_ULOG.man      |  4 ++--
 extensions/libxt_CT.man         |  4 ++--
 extensions/libxt_HMARK.man      |  2 +-
 extensions/libxt_LED.man        |  4 ++--
 extensions/libxt_MASQUERADE.man |  6 +++---
 extensions/libxt_NFLOG.man      |  4 ++--
 extensions/libxt_NFQUEUE.man    | 11 ++++++-----
 extensions/libxt_SET.man        |  4 ++--
 extensions/libxt_SNAT.man       |  2 +-
 extensions/libxt_SYNPROXY.man   |  4 ++--
 extensions/libxt_TRACE.man      |  4 ++--
 extensions/libxt_bpf.man        |  8 ++++----
 extensions/libxt_cgroup.man     |  2 +-
 extensions/libxt_cluster.man    |  8 ++++----
 extensions/libxt_connlabel.man  | 10 +++++-----
 extensions/libxt_connlimit.man  | 31 ++++++++++++++++++-------------
 extensions/libxt_cpu.man        |  2 +-
 extensions/libxt_dscp.man       |  2 +-
 extensions/libxt_hashlimit.man  |  6 +++---
 extensions/libxt_helper.man     | 10 +++++-----
 extensions/libxt_limit.man      |  2 +-
 extensions/libxt_nfacct.man     |  2 +-
 extensions/libxt_osf.man        | 40 +++++++++++++++++++++++++---------------
 extensions/libxt_owner.man      |  2 +-
 extensions/libxt_rateest.man    | 16 ++++++++++------
 extensions/libxt_socket.man     |  2 +-
 extensions/libxt_time.man       |  2 +-
 extensions/libxt_u32.man        | 16 ++++++++--------
 iptables/ebtables-nft.8         | 22 +++++++++++-----------
 33 files changed, 136 insertions(+), 114 deletions(-)
Phil Sutter Oct. 27, 2023, 11:10 a.m. UTC | #3
On Thu, Oct 26, 2023 at 05:10:07PM +0200, Jan Engelhardt wrote:
> On Thursday 2023-10-26 14:53, Phil Sutter wrote:
> >> diff --git a/extensions/libxt_MASQUERADE.man b/extensions/libxt_MASQUERADE.man
> >> index e2009086..7cc2bb7a 100644
> >> --- a/extensions/libxt_MASQUERADE.man
> >> +++ b/extensions/libxt_MASQUERADE.man
> >> @@ -15,7 +15,7 @@ any established connections are lost anyway).
> >>  \fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP]
> >>  This specifies a range of source ports to use, overriding the default
> >>  .B SNAT
> >> -source port-selection heuristics (see above).  This is only valid
> >> +source port-selection heuristics (see above). This is only valid
> >
> >Do you miss a dash in:
> >
> >"default SNAT source port selection heuristics"? I lean towards putting
> >dashes everywhere, but my language spoils me. ;)
> 
> Third time's the charm, hopefully?

Did you intentionally revert from '\[-]' back to '\-' in math formulae?
Apart from that, your updated series looks good to me.

Thanks, Phil
Jan Engelhardt Oct. 27, 2023, 1:08 p.m. UTC | #4
On Friday 2023-10-27 13:10, Phil Sutter wrote:
>> >
>> >"default SNAT source port selection heuristics"? I lean towards putting
>> >dashes everywhere, but my language spoils me. ;)
>> 
>> Third time's the charm, hopefully?
>
>Did you intentionally revert from '\[-]' back to '\-' in math formulae?

Yes I gave my reasoning in
 Message-ID: <n5qnp222-6p4s-r2p4-p6oq-0s1n4qq5496n@vanv.qr>

\[-] is GNU-specific syntax.
Phil Sutter Oct. 27, 2023, 4:01 p.m. UTC | #5
On Fri, Oct 27, 2023 at 03:08:20PM +0200, Jan Engelhardt wrote:
> On Friday 2023-10-27 13:10, Phil Sutter wrote:
> >> >
> >> >"default SNAT source port selection heuristics"? I lean towards putting
> >> >dashes everywhere, but my language spoils me. ;)
> >> 
> >> Third time's the charm, hopefully?
> >
> >Did you intentionally revert from '\[-]' back to '\-' in math formulae?
> 
> Yes I gave my reasoning in
>  Message-ID: <n5qnp222-6p4s-r2p4-p6oq-0s1n4qq5496n@vanv.qr>

You were a bit vague in there, I couldn't quite tell whether you were to
change them or not.

> \[-] is GNU-specific syntax.

OK, fine. Meanwhile pushed your patches, thanks!
diff mbox series

Patch

diff --git a/extensions/libxt_MASQUERADE.man b/extensions/libxt_MASQUERADE.man
index e2009086..7cc2bb7a 100644
--- a/extensions/libxt_MASQUERADE.man
+++ b/extensions/libxt_MASQUERADE.man
@@ -15,7 +15,7 @@  any established connections are lost anyway).
 \fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP]
 This specifies a range of source ports to use, overriding the default
 .B SNAT
-source port-selection heuristics (see above).  This is only valid
+source port-selection heuristics (see above). This is only valid
 if the rule also specifies one of the following protocols:
 \fBtcp\fP, \fBudp\fP, \fBdccp\fP or \fBsctp\fP.
 .TP
diff --git a/extensions/libxt_helper.man b/extensions/libxt_helper.man
index 772b1350..fb8a206c 100644
--- a/extensions/libxt_helper.man
+++ b/extensions/libxt_helper.man
@@ -1,11 +1,11 @@ 
-This module matches packets related to a specific conntrack-helper.
+This module matches packets related to a specific conntrack helper.
 .TP
 [\fB!\fP] \fB\-\-helper\fP \fIstring\fP
-Matches packets related to the specified conntrack-helper.
+Matches packets related to the specified conntrack helper.
 .RS
 .PP
-string can be "ftp" for packets related to a ftp-session on default port.
-For other ports append \-portnr to the value, ie. "ftp\-2121".
+string can be "ftp" for packets related to an FTP session on default port.
+For other ports, append \-\-portnr to the value, ie. "ftp\-2121".
 .PP
-Same rules apply for other conntrack-helpers.
+Same rules apply for other conntrack helpers.
 .RE