public inbox for passt-dev@passt.top
 help / color / mirror / code / Atom feed
From: Stefano Brivio <sbrivio@redhat.com>
To: passt-dev@passt.top
Cc: Laine Stump <laine@redhat.com>, Yalan Zhang <yalzhang@redhat.com>
Subject: [PATCH] passt.1: Fix typo, improve wording in examples of port forwarding specifiers
Date: Thu, 16 Feb 2023 02:09:00 +0100	[thread overview]
Message-ID: <20230216010900.2224288-1-sbrivio@redhat.com> (raw)

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>
---
 passt.1 | 29 ++++++++++++++++-------------
 1 file changed, 16 insertions(+), 13 deletions(-)

diff --git a/passt.1 b/passt.1
index 528763b..ec09c22 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,11 @@ 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 corresponding ports on the guest, plus
+10
 .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 +360,10 @@ 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, but not between 3000 to 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
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
 .TP
 -t ~20000-20010
 Forward all ports to the guest, except for the range from 20000 to 20010
@@ -425,12 +426,13 @@ 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
-.TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports plus 10 in the target
+Forward local ports between 22 and 80 to corresponding ports in the target
 namespace
 .TP
+-t 22-80:32-90
+Forward local ports between 22 and 80 to corresponding ports, plus 10, in the
+target namespace
+.TP
 -t 192.0.2.1/22
 Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
 .TP
@@ -438,13 +440,14 @@ 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, but not between 3000 to 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
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
 .TP
 -t ~20000-20010
-Forward all ports to the namespace, except for the range from 20000 to 20010
+Forward all ports to the target namespace, except for the range from 20000 to
+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,11 @@ 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 corresponding ports on the guest, plus
+10
 .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 +360,10 @@ 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, but not between 3000 to 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
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
 .TP
 -t ~20000-20010
 Forward all ports to the guest, except for the range from 20000 to 20010
@@ -425,12 +426,13 @@ 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
-.TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports plus 10 in the target
+Forward local ports between 22 and 80 to corresponding ports in the target
 namespace
 .TP
+-t 22-80:32-90
+Forward local ports between 22 and 80 to corresponding ports, plus 10, in the
+target namespace
+.TP
 -t 192.0.2.1/22
 Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
 .TP
@@ -438,13 +440,14 @@ 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, but not between 3000 to 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
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
 .TP
 -t ~20000-20010
-Forward all ports to the namespace, except for the range from 20000 to 20010
+Forward all ports to the target namespace, except for the range from 20000 to
+20010
 .RE
 
 IPv6 bound ports are also forwarded for IPv4.
-- 
2.35.1


             reply	other threads:[~2023-02-16  1:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-16  1:09 Stefano Brivio [this message]
2023-02-16  2:44 ` [PATCH] passt.1: Fix typo, improve wording in examples of port forwarding specifiers David Gibson
2023-02-16  7:19   ` Stefano Brivio

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230216010900.2224288-1-sbrivio@redhat.com \
    --to=sbrivio@redhat.com \
    --cc=laine@redhat.com \
    --cc=passt-dev@passt.top \
    --cc=yalzhang@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://passt.top/passt

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for IMAP folder(s).