diff mbox series

[iproute2-next,v2,2/2] bridge: vlan: fix compressvlans usage

Message ID MAZP287MB0503BB0A5D2584B43A734CB6E4312@MAZP287MB0503.INDP287.PROD.OUTLOOK.COM (mailing list archive)
State Accepted
Commit 9ccf8fa8d4d7279bb70507e09ffa712359639287
Delegated to: Stephen Hemminger
Headers show
Series bridge: vlan: add compressvlans manpage | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Date Huang March 22, 2024, 12:39 p.m. UTC
Add the missing 'compressvlans' to man page

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

Comments

Nikolay Aleksandrov March 22, 2024, 12:54 p.m. UTC | #1
On 3/22/24 14:39, Date Huang wrote:
> Add the missing 'compressvlans' to man page
> 
> Signed-off-by: Date Huang <tjjh89017@hotmail.com>
> ---
>   man/man8/bridge.8 | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
> index eeea4073..bb02bd27 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\-com\fR[\fIpressvlans\fR] |
>   \fB\-c\fR[\fIolor\fR] |
>   \fB\-p\fR[\fIretty\fR] |
>   \fB\-j\fR[\fIson\fR] |
> @@ -345,6 +346,11 @@ 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 "\-com", " \-compressvlans"
> +Show compressed VLAN list. It will show continuous VLANs with the range instead
> +of separated VLANs. Default is off.
> +

How about:
Show a compressed VLAN list of continuous VLAN IDs as ranges. All VLANs 
in a range have identical configuration. Default is off (show each VLAN 
separately).

>   .TP
>   .BR \-c [ color ][ = { always | auto | never }
>   Configure color output. If parameter is omitted or
Stephen Hemminger March 22, 2024, 3:41 p.m. UTC | #2
On Fri, 22 Mar 2024 20:39:23 +0800
Date Huang <tjjh89017@hotmail.com> wrote:

> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
> index eeea4073..bb02bd27 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\-com\fR[\fIpressvlans\fR] |
>  \fB\-c\fR[\fIolor\fR] |
>  \fB\-p\fR[\fIretty\fR] |
>  \fB\-j\fR[\fIson\fR] |
> @@ -345,6 +346,11 @@ 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 "\-com", " \-compressvlans"
> +Show compressed VLAN list. It will show continuous VLANs with the range instead
> +of separated VLANs. Default is off.
> +

Overlapping option strings can cause problems, maybe a better word?
Date Huang March 25, 2024, 5:34 a.m. UTC | #3
Hi Stephen

On 3/22/2024 11:41 PM, Stephen Hemminger wrote:
> On Fri, 22 Mar 2024 20:39:23 +0800
> Date Huang <tjjh89017@hotmail.com> wrote:
> 
>> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
>> index eeea4073..bb02bd27 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\-com\fR[\fIpressvlans\fR] |
>>   \fB\-c\fR[\fIolor\fR] |
>>   \fB\-p\fR[\fIretty\fR] |
>>   \fB\-j\fR[\fIson\fR] |
>> @@ -345,6 +346,11 @@ 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 "\-com", " \-compressvlans"
>> +Show compressed VLAN list. It will show continuous VLANs with the range instead
>> +of separated VLANs. Default is off.
>> +
> 
> Overlapping option strings can cause problems, maybe a better word?

I just add the missing manual page and change the usage for the current 
implementation. Maybe you could suggest some better option string for us?

Thank you
Date
diff mbox series

Patch

diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
index eeea4073..bb02bd27 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\-com\fR[\fIpressvlans\fR] |
 \fB\-c\fR[\fIolor\fR] |
 \fB\-p\fR[\fIretty\fR] |
 \fB\-j\fR[\fIson\fR] |
@@ -345,6 +346,11 @@  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 "\-com", " \-compressvlans"
+Show compressed VLAN list. It will show continuous VLANs with the range instead
+of separated VLANs. Default is off.
+
 .TP
 .BR \-c [ color ][ = { always | auto | never }
 Configure color output. If parameter is omitted or