diff mbox series

bridge: vlan: fix compressvlans manpage and usage

Message ID MAZP287MB0503CBCF2FB4C165F0460D70E4312@MAZP287MB0503.INDP287.PROD.OUTLOOK.COM (mailing list archive)
State Changes Requested
Delegated to: Stephen Hemminger
Headers show
Series bridge: vlan: fix compressvlans manpage and usage | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Date Huang March 22, 2024, 8:56 a.m. UTC
Add the missing 'compressvlans' to man page.
Fix the incorrect short opt for compressvlans and color
in usage.

Signed-off-by: Date Huang <tjjh89017@hotmail.com>
---
 bridge/bridge.c   | 2 +-
 man/man8/bridge.8 | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)

Comments

Nikolay Aleksandrov March 22, 2024, 9:25 a.m. UTC | #1
On 3/22/24 10:56, Date Huang wrote:
> Add the missing 'compressvlans' to man page.
> Fix the incorrect short opt for compressvlans and color
> in usage.
> 
> Signed-off-by: Date Huang <tjjh89017@hotmail.com>
> ---

Hi,
This should be targeted at iproute2. Nit below,

>   bridge/bridge.c   | 2 +-
>   man/man8/bridge.8 | 5 +++++
>   2 files changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/bridge/bridge.c b/bridge/bridge.c
> index f4805092..345f5b5f 100644
> --- a/bridge/bridge.c
> +++ b/bridge/bridge.c
> @@ -39,7 +39,7 @@ static void usage(void)
>   "where  OBJECT := { link | fdb | mdb | vlan | vni | monitor }\n"
>   "       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] |\n"
>   "                    -o[neline] | -t[imestamp] | -n[etns] name |\n"
> -"                    -c[ompressvlans] -color -p[retty] -j[son] }\n");
> +"                    -compressvlans -c[olor] -p[retty] -j[son] }\n");
>   	exit(-1);
>   }
>   
> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
> index eeea4073..9a023227 100644
> --- a/man/man8/bridge.8
> +++ b/man/man8/bridge.8
> @@ -22,6 +22,7 @@ bridge \- show / manipulate bridge addresses and devices
>   \fB\-s\fR[\fItatistics\fR] |
>   \fB\-n\fR[\fIetns\fR] name |
>   \fB\-b\fR[\fIatch\fR] filename |
> +\fB\-compressvlans |
>   \fB\-c\fR[\fIolor\fR] |
>   \fB\-p\fR[\fIretty\fR] |
>   \fB\-j\fR[\fIson\fR] |
> @@ -345,6 +346,10 @@ Don't terminate bridge command on errors in batch mode.
>   If there were any errors during execution of the commands, the application
>   return code will be non zero.
>   
> +.TP
> +.BR \-compressvlans
> +Show compressed vlan list

s/vlan/VLAN/
also the explanation is lacking, please add a little bit of details and
what the default is

> +
>   .TP
>   .BR \-c [ color ][ = { always | auto | never }
>   Configure color output. If parameter is omitted or

Thanks,
  Nik
Jiri Pirko March 22, 2024, 9:40 a.m. UTC | #2
Fri, Mar 22, 2024 at 09:56:29AM CET, tjjh89017@hotmail.com wrote:
>Add the missing 'compressvlans' to man page.
>Fix the incorrect short opt for compressvlans and color
>in usage.

Split to 2 patches please.

Please fix your prefix to be in format "[patch iproute2-next] xxx"
to properly indicate the target project and tree.


>
>Signed-off-by: Date Huang <tjjh89017@hotmail.com>
>---
> bridge/bridge.c   | 2 +-
> man/man8/bridge.8 | 5 +++++
> 2 files changed, 6 insertions(+), 1 deletion(-)
>
>diff --git a/bridge/bridge.c b/bridge/bridge.c
>index f4805092..345f5b5f 100644
>--- a/bridge/bridge.c
>+++ b/bridge/bridge.c
>@@ -39,7 +39,7 @@ static void usage(void)
> "where  OBJECT := { link | fdb | mdb | vlan | vni | monitor }\n"
> "       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] |\n"
> "                    -o[neline] | -t[imestamp] | -n[etns] name |\n"
>-"                    -c[ompressvlans] -color -p[retty] -j[son] }\n");
>+"                    -compressvlans -c[olor] -p[retty] -j[son] }\n");

From how I read the code, shouldn't this be rather:
  "                    -com[pressvlans] -c[olor] -p[retty] -j[son] }\n");
?

> 	exit(-1);
> }
> 
>diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
>index eeea4073..9a023227 100644
>--- a/man/man8/bridge.8
>+++ b/man/man8/bridge.8
>@@ -22,6 +22,7 @@ bridge \- show / manipulate bridge addresses and devices
> \fB\-s\fR[\fItatistics\fR] |
> \fB\-n\fR[\fIetns\fR] name |
> \fB\-b\fR[\fIatch\fR] filename |
>+\fB\-compressvlans |
> \fB\-c\fR[\fIolor\fR] |
> \fB\-p\fR[\fIretty\fR] |
> \fB\-j\fR[\fIson\fR] |
>@@ -345,6 +346,10 @@ Don't terminate bridge command on errors in batch mode.
> If there were any errors during execution of the commands, the application
> return code will be non zero.
> 
>+.TP
>+.BR \-compressvlans
>+Show compressed vlan list
>+
> .TP
> .BR \-c [ color ][ = { always | auto | never }
> Configure color output. If parameter is omitted or
>-- 
>2.34.1
>
>
Date Huang March 22, 2024, 12:32 p.m. UTC | #3
Hi Nikolay

On 3/22/2024 5:25 PM, Nikolay Aleksandrov wrote:
> On 3/22/24 10:56, Date Huang wrote:
>> Add the missing 'compressvlans' to man page.
>> Fix the incorrect short opt for compressvlans and color
>> in usage.
>>
>> Signed-off-by: Date Huang <tjjh89017@hotmail.com>
>> ---
> 
> Hi,
> This should be targeted at iproute2. Nit below,

Thank you, I will update this in the latest patch.

> 
>>   bridge/bridge.c   | 2 +-
>>   man/man8/bridge.8 | 5 +++++
>>   2 files changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/bridge/bridge.c b/bridge/bridge.c
>> index f4805092..345f5b5f 100644
>> --- a/bridge/bridge.c
>> +++ b/bridge/bridge.c
>> @@ -39,7 +39,7 @@ static void usage(void)
>>   "where  OBJECT := { link | fdb | mdb | vlan | vni | monitor }\n"
>>   "       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] |\n"
>>   "                    -o[neline] | -t[imestamp] | -n[etns] name |\n"
>> -"                    -c[ompressvlans] -color -p[retty] -j[son] }\n");
>> +"                    -compressvlans -c[olor] -p[retty] -j[son] }\n");
>>       exit(-1);
>>   }
>> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
>> index eeea4073..9a023227 100644
>> --- a/man/man8/bridge.8
>> +++ b/man/man8/bridge.8
>> @@ -22,6 +22,7 @@ bridge \- show / manipulate bridge addresses and 
>> devices
>>   \fB\-s\fR[\fItatistics\fR] |
>>   \fB\-n\fR[\fIetns\fR] name |
>>   \fB\-b\fR[\fIatch\fR] filename |
>> +\fB\-compressvlans |
>>   \fB\-c\fR[\fIolor\fR] |
>>   \fB\-p\fR[\fIretty\fR] |
>>   \fB\-j\fR[\fIson\fR] |
>> @@ -345,6 +346,10 @@ Don't terminate bridge command on errors in batch 
>> mode.
>>   If there were any errors during execution of the commands, the 
>> application
>>   return code will be non zero.
>> +.TP
>> +.BR \-compressvlans
>> +Show compressed vlan list
> 
> s/vlan/VLAN/
> also the explanation is lacking, please add a little bit of details and
> what the default is

Ok, I updated this in the latest patch v2.

> 
>> +
>>   .TP
>>   .BR \-c [ color ][ = { always | auto | never }
>>   Configure color output. If parameter is omitted or
> 
> Thanks,
>   Nik
> 

Thanks,
Date
Date Huang March 22, 2024, 12:33 p.m. UTC | #4
Hi Jiri

On 3/22/2024 5:40 PM, Jiri Pirko wrote:
> Fri, Mar 22, 2024 at 09:56:29AM CET, tjjh89017@hotmail.com wrote:
>> Add the missing 'compressvlans' to man page.
>> Fix the incorrect short opt for compressvlans and color
>> in usage.
> 
> Split to 2 patches please.
> 
> Please fix your prefix to be in format "[patch iproute2-next] xxx"
> to properly indicate the target project and tree.

Thank you, I will update this in v2.

> 
> 
>>
>> Signed-off-by: Date Huang <tjjh89017@hotmail.com>
>> ---
>> bridge/bridge.c   | 2 +-
>> man/man8/bridge.8 | 5 +++++
>> 2 files changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/bridge/bridge.c b/bridge/bridge.c
>> index f4805092..345f5b5f 100644
>> --- a/bridge/bridge.c
>> +++ b/bridge/bridge.c
>> @@ -39,7 +39,7 @@ static void usage(void)
>> "where  OBJECT := { link | fdb | mdb | vlan | vni | monitor }\n"
>> "       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] |\n"
>> "                    -o[neline] | -t[imestamp] | -n[etns] name |\n"
>> -"                    -c[ompressvlans] -color -p[retty] -j[son] }\n");
>> +"                    -compressvlans -c[olor] -p[retty] -j[son] }\n");
> 
>  From how I read the code, shouldn't this be rather:
>    "                    -com[pressvlans] -c[olor] -p[retty] -j[son] }\n");
> ?

Agree with you, I will update it in v2.

> 
>> 	exit(-1);
>> }
>>
>> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
>> index eeea4073..9a023227 100644
>> --- a/man/man8/bridge.8
>> +++ b/man/man8/bridge.8
>> @@ -22,6 +22,7 @@ bridge \- show / manipulate bridge addresses and devices
>> \fB\-s\fR[\fItatistics\fR] |
>> \fB\-n\fR[\fIetns\fR] name |
>> \fB\-b\fR[\fIatch\fR] filename |
>> +\fB\-compressvlans |
>> \fB\-c\fR[\fIolor\fR] |
>> \fB\-p\fR[\fIretty\fR] |
>> \fB\-j\fR[\fIson\fR] |
>> @@ -345,6 +346,10 @@ Don't terminate bridge command on errors in batch mode.
>> If there were any errors during execution of the commands, the application
>> return code will be non zero.
>>
>> +.TP
>> +.BR \-compressvlans
>> +Show compressed vlan list
>> +
>> .TP
>> .BR \-c [ color ][ = { always | auto | never }
>> Configure color output. If parameter is omitted or
>> -- 
>> 2.34.1
>>
>>

Thanks,
Date
diff mbox series

Patch

diff --git a/bridge/bridge.c b/bridge/bridge.c
index f4805092..345f5b5f 100644
--- a/bridge/bridge.c
+++ b/bridge/bridge.c
@@ -39,7 +39,7 @@  static void usage(void)
 "where  OBJECT := { link | fdb | mdb | vlan | vni | monitor }\n"
 "       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] |\n"
 "                    -o[neline] | -t[imestamp] | -n[etns] name |\n"
-"                    -c[ompressvlans] -color -p[retty] -j[son] }\n");
+"                    -compressvlans -c[olor] -p[retty] -j[son] }\n");
 	exit(-1);
 }
 
diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
index eeea4073..9a023227 100644
--- a/man/man8/bridge.8
+++ b/man/man8/bridge.8
@@ -22,6 +22,7 @@  bridge \- show / manipulate bridge addresses and devices
 \fB\-s\fR[\fItatistics\fR] |
 \fB\-n\fR[\fIetns\fR] name |
 \fB\-b\fR[\fIatch\fR] filename |
+\fB\-compressvlans |
 \fB\-c\fR[\fIolor\fR] |
 \fB\-p\fR[\fIretty\fR] |
 \fB\-j\fR[\fIson\fR] |
@@ -345,6 +346,10 @@  Don't terminate bridge command on errors in batch mode.
 If there were any errors during execution of the commands, the application
 return code will be non zero.
 
+.TP
+.BR \-compressvlans
+Show compressed vlan list
+
 .TP
 .BR \-c [ color ][ = { always | auto | never }
 Configure color output. If parameter is omitted or