[PATCH v2] passt.1: Fix typo, improve wording in examples of port forwarding specifiers

[PATCH v2] passt.1: Fix typo, improve wording in examples of port forwarding specifiers

[Stefano Brivio]

Based on a patch from Laine, and reports from Laine and Yalan: fix
the "22-80:32-90" example, and improve wording for the other ones:
instead of using "to" to denote the end of a range, use "between ...
and", so that it's clear we're *not* referring to target ports.

Reported-by: Laine Stump <laine@redhat.com>
Reported-by: Yalan Zhang <yalzhang@redhat.com>
Fixes: da20f57f19dc ("passt, qrap: Add man pages")
Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
---
v2: Adopted further changes proposed by David

 passt.1 | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/passt.1 b/passt.1
index 528763b..f317c33 100644
--- a/passt.1
+++ b/passt.1
@@ -338,7 +338,7 @@ Examples:
 .RS
 .TP
 -t 22
-Forward local port 22 to 22 on the guest
+Forward local port 22 to port 22 on the guest
 .TP
 -t 22:23
 Forward local port 22 to port 23 on the guest
@@ -347,10 +347,10 @@ Forward local port 22 to port 23 on the guest
 Forward local ports 22 and 25 to ports 22 and 25 on the guest
 .TP
 -t 22-80
-Forward local ports 22 to 80 to corresponding ports on the guest
+Forward local ports between 22 and 80 to corresponding ports on the guest
 .TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports on the guest plus 10
+-t 22-80:32-90
+Forward local ports between 22 and 80 to ports between 32 and 90 on the guest
 .TP
 -t 192.0.2.1/22
 Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
@@ -359,10 +359,12 @@ Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
 Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
 .TP
 -t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, except for those between 3000 and
+3010
 .TP
 -t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
+and 30
 .TP
 -t ~20000-20010
 Forward all ports to the guest, except for the range from 20000 to 20010
@@ -425,10 +427,11 @@ Forward local port 22 to port 23 in the target namespace
 Forward local ports 22 and 25 to ports 22 and 25 in the target namespace
 .TP
 -t 22-80
-Forward local ports 22 to 80 to corresponding ports in the target namespace
+Forward local ports between 22 and 80 to corresponding ports in the target
+namespace
 .TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports plus 10 in the target
+-t 22-80:32-90
+Forward local ports between 22 and 80 to ports between 32 and 90 in the target
 namespace
 .TP
 -t 192.0.2.1/22
@@ -438,13 +441,15 @@ Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
 Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
 .TP
 -t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, except for those between 3000 and
+3010
 .TP
 -t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
+and 30
 .TP
 -t ~20000-20010
-Forward all ports to the namespace, except for the range from 20000 to 20010
+Forward all ports to the namespace, except for those between 20000 and 20010
 .RE
 
 IPv6 bound ports are also forwarded for IPv4.
-- 
@@ -338,7 +338,7 @@ Examples:
 .RS
 .TP
 -t 22
-Forward local port 22 to 22 on the guest
+Forward local port 22 to port 22 on the guest
 .TP
 -t 22:23
 Forward local port 22 to port 23 on the guest
@@ -347,10 +347,10 @@ Forward local port 22 to port 23 on the guest
 Forward local ports 22 and 25 to ports 22 and 25 on the guest
 .TP
 -t 22-80
-Forward local ports 22 to 80 to corresponding ports on the guest
+Forward local ports between 22 and 80 to corresponding ports on the guest
 .TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports on the guest plus 10
+-t 22-80:32-90
+Forward local ports between 22 and 80 to ports between 32 and 90 on the guest
 .TP
 -t 192.0.2.1/22
 Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
@@ -359,10 +359,12 @@ Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
 Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
 .TP
 -t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, except for those between 3000 and
+3010
 .TP
 -t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
+and 30
 .TP
 -t ~20000-20010
 Forward all ports to the guest, except for the range from 20000 to 20010
@@ -425,10 +427,11 @@ Forward local port 22 to port 23 in the target namespace
 Forward local ports 22 and 25 to ports 22 and 25 in the target namespace
 .TP
 -t 22-80
-Forward local ports 22 to 80 to corresponding ports in the target namespace
+Forward local ports between 22 and 80 to corresponding ports in the target
+namespace
 .TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports plus 10 in the target
+-t 22-80:32-90
+Forward local ports between 22 and 80 to ports between 32 and 90 in the target
 namespace
 .TP
 -t 192.0.2.1/22
@@ -438,13 +441,15 @@ Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
 Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
 .TP
 -t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, except for those between 3000 and
+3010
 .TP
 -t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
+and 30
 .TP
 -t ~20000-20010
-Forward all ports to the namespace, except for the range from 20000 to 20010
+Forward all ports to the namespace, except for those between 20000 and 20010
 .RE
 
 IPv6 bound ports are also forwarded for IPv4.
-- 
2.35.1

Re: [PATCH v2] passt.1: Fix typo, improve wording in examples of port forwarding specifiers

[Laine Stump]

On 2/16/23 2:23 AM, Stefano Brivio wrote:
> Based on a patch from Laine, and reports from Laine and Yalan: fix
> the "22-80:32-90" example, and improve wording for the other ones:
> instead of using "to" to denote the end of a range, use "between ...
> and", so that it's clear we're *not* referring to target ports.
> 
> Reported-by: Laine Stump <laine@redhat.com>
> Reported-by: Yalan Zhang <yalzhang@redhat.com>
> Fixes: da20f57f19dc ("passt, qrap: Add man pages")
> Signed-off-by: Stefano Brivio <sbrivio@redhat.com>

Reviewed-by: Laine Stump <laine@redhat.com>

(if I'm allowed :-)

> ---
> v2: Adopted further changes proposed by David
> 
>   passt.1 | 29 +++++++++++++++++------------
>   1 file changed, 17 insertions(+), 12 deletions(-)
> 
> diff --git a/passt.1 b/passt.1
> index 528763b..f317c33 100644
> --- a/passt.1
> +++ b/passt.1
> @@ -338,7 +338,7 @@ Examples:
>   .RS
>   .TP
>   -t 22
> -Forward local port 22 to 22 on the guest
> +Forward local port 22 to port 22 on the guest
>   .TP
>   -t 22:23
>   Forward local port 22 to port 23 on the guest
> @@ -347,10 +347,10 @@ Forward local port 22 to port 23 on the guest
>   Forward local ports 22 and 25 to ports 22 and 25 on the guest
>   .TP
>   -t 22-80
> -Forward local ports 22 to 80 to corresponding ports on the guest
> +Forward local ports between 22 and 80 to corresponding ports on the guest
>   .TP
> --t 22-80-32:90
> -Forward local ports 22 to 80 to corresponding ports on the guest plus 10
> +-t 22-80:32-90
> +Forward local ports between 22 and 80 to ports between 32 and 90 on the guest
>   .TP
>   -t 192.0.2.1/22
>   Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
> @@ -359,10 +359,12 @@ Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
>   Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
>   .TP
>   -t 2000-5000,~3000-3010
> -Forward local ports 2000 to 5000, but not 3000 to 3010
> +Forward local ports between 2000 and 5000, except for those between 3000 and
> +3010
>   .TP
>   -t 192.0.2.1/20-30,~25
> -Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
> +For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
> +and 30
>   .TP
>   -t ~20000-20010
>   Forward all ports to the guest, except for the range from 20000 to 20010
> @@ -425,10 +427,11 @@ Forward local port 22 to port 23 in the target namespace
>   Forward local ports 22 and 25 to ports 22 and 25 in the target namespace
>   .TP
>   -t 22-80
> -Forward local ports 22 to 80 to corresponding ports in the target namespace
> +Forward local ports between 22 and 80 to corresponding ports in the target
> +namespace
>   .TP
> --t 22-80-32:90
> -Forward local ports 22 to 80 to corresponding ports plus 10 in the target
> +-t 22-80:32-90
> +Forward local ports between 22 and 80 to ports between 32 and 90 in the target
>   namespace
>   .TP
>   -t 192.0.2.1/22
> @@ -438,13 +441,15 @@ Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
>   Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
>   .TP
>   -t 2000-5000,~3000-3010
> -Forward local ports 2000 to 5000, but not 3000 to 3010
> +Forward local ports between 2000 and 5000, except for those between 3000 and
> +3010
>   .TP
>   -t 192.0.2.1/20-30,~25
> -Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
> +For the local address 192.0.2.1, forward ports between 20 and 24 and between 26
> +and 30
>   .TP
>   -t ~20000-20010
> -Forward all ports to the namespace, except for the range from 20000 to 20010
> +Forward all ports to the namespace, except for those between 20000 and 20010
>   .RE
>   
>   IPv6 bound ports are also forwarded for IPv4.

Re: [PATCH v2] passt.1: Fix typo, improve wording in examples of port forwarding specifiers

[Stefano Brivio]

On Thu, 16 Feb 2023 11:53:07 -0500
Laine Stump <laine@redhat.com> wrote:

> On 2/16/23 2:23 AM, Stefano Brivio wrote:
> > Based on a patch from Laine, and reports from Laine and Yalan: fix
> > the "22-80:32-90" example, and improve wording for the other ones:
> > instead of using "to" to denote the end of a range, use "between ...
> > and", so that it's clear we're *not* referring to target ports.
> > 
> > Reported-by: Laine Stump <laine@redhat.com>
> > Reported-by: Yalan Zhang <yalzhang@redhat.com>
> > Fixes: da20f57f19dc ("passt, qrap: Add man pages")
> > Signed-off-by: Stefano Brivio <sbrivio@redhat.com>  
> 
> Reviewed-by: Laine Stump <laine@redhat.com>
> 
> (if I'm allowed :-)

Oops, not anymore, I'm in the middle of pushing things out and running
tests, I just pushed this, and I want to avoid rebasing the tree.

-- 
Stefano

Re: [PATCH v2] passt.1: Fix typo, improve wording in examples of port forwarding specifiers

[Laine Stump]

On 2/16/23 12:32 PM, Stefano Brivio wrote:
> On Thu, 16 Feb 2023 11:53:07 -0500
> Laine Stump <laine@redhat.com> wrote:
> 
>> On 2/16/23 2:23 AM, Stefano Brivio wrote:
>>> Based on a patch from Laine, and reports from Laine and Yalan: fix
>>> the "22-80:32-90" example, and improve wording for the other ones:
>>> instead of using "to" to denote the end of a range, use "between ...
>>> and", so that it's clear we're *not* referring to target ports.
>>>
>>> Reported-by: Laine Stump <laine@redhat.com>
>>> Reported-by: Yalan Zhang <yalzhang@redhat.com>
>>> Fixes: da20f57f19dc ("passt, qrap: Add man pages")
>>> Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
>>
>> Reviewed-by: Laine Stump <laine@redhat.com>
>>
>> (if I'm allowed :-)
> 
> Oops, not anymore, I'm in the middle of pushing things out and running
> tests, I just pushed this, and I want to avoid rebasing the tree.
> 


Oh, I wasn't talking about whether or not I "get documented credit for 
spending a few minutes looking at someone else's work". Just saying the 
equivalent of "Another set of eyes has looked at it and it seemed good", 
although I guess using the official rb header to do that may imply 
otherwise; that's just a force of habit :-)