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

On Thu, 16 Feb 2023 13:44:20 +1100 David Gibson wrote:

On Thu, Feb 16, 2023 at 02:09:00AM +0100, 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 Reported-by: Yalan Zhang Fixes: da20f57f19dc ("passt, qrap: Add man pages") Signed-off-by: Stefano Brivio

Reviewed-by: David Gibson

Although, a few additional refinements suggested below:

...

--- 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

I find it a bit hard to parse how the "plus 10" attaches to the rest of the sentence. I'd suggest:

Forward local ports between 22 and 80 to ports between 32 and 90 on the guest.

From a pedantic point of view that's less precise, but I think the meaning of it going to be clearer in practice to most readers

Ah, yes, thanks, much better. Same for all the other suggestions. Posting v2. -- Stefano