diff mbox series

[iproute2,v4,3/3] man: Add -bs option to tc manpage

Message ID 20180102142804.27145-4-chrism@mellanox.com
State Changes Requested, archived
Delegated to: David Ahern
Headers show
Series tc: Add -bs option to batch mode | expand

Commit Message

Chris Mi Jan. 2, 2018, 2:28 p.m. UTC
Signed-off-by: Chris Mi <chrism@mellanox.com>
---
 man/man8/tc.8 | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Marcelo Ricardo Leitner Jan. 2, 2018, 8:07 p.m. UTC | #1
On Tue, Jan 02, 2018 at 11:28:04PM +0900, Chris Mi wrote:
> Signed-off-by: Chris Mi <chrism@mellanox.com>
> ---
>  man/man8/tc.8 | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/man/man8/tc.8 b/man/man8/tc.8
> index ff071b33..de137e16 100644
> --- a/man/man8/tc.8
> +++ b/man/man8/tc.8
> @@ -601,6 +601,11 @@ must exist already.
>  read commands from provided file or standard input and invoke them.
>  First failure will cause termination of tc.
>  
> +.TP
> +.BR "\-bs", " \-bs size", " \-batchsize", " \-batchsize size"
> +How many commands are accumulated before sending to kernel.
> +By default, it is 1. It only takes effect in batch mode.
> +

You should also describe the limitations it has. Like, it only works
for action and filter and that it shouldn't be mixed with other
commands.
And maybe even do such check in the code: refuse to do other commands
if batch_size > 1.

>  .TP
>  .BR "\-force"
>  don't terminate tc on errors in batch mode.
> -- 
> 2.14.3
>
Chris Mi Jan. 3, 2018, 2:48 a.m. UTC | #2
2018/1/3 4:07, Marcelo Ricardo Leitner:
> On Tue, Jan 02, 2018 at 11:28:04PM +0900, Chris Mi wrote:
>> Signed-off-by: Chris Mi <chrism@mellanox.com>
>> ---
>>   man/man8/tc.8 | 5 +++++
>>   1 file changed, 5 insertions(+)
>>
>> diff --git a/man/man8/tc.8 b/man/man8/tc.8
>> index ff071b33..de137e16 100644
>> --- a/man/man8/tc.8
>> +++ b/man/man8/tc.8
>> @@ -601,6 +601,11 @@ must exist already.
>>   read commands from provided file or standard input and invoke them.
>>   First failure will cause termination of tc.
>>   
>> +.TP
>> +.BR "\-bs", " \-bs size", " \-batchsize", " \-batchsize size"
>> +How many commands are accumulated before sending to kernel.
>> +By default, it is 1. It only takes effect in batch mode.
>> +
> You should also describe the limitations it has. Like, it only works
> for action and filter and that it shouldn't be mixed with other
> commands.
Done.
> And maybe even do such check in the code: refuse to do other commands
> if batch_size > 1.
I didn't add it because I'm afraid the benefit may be gone if I add the 
check.
But I add a warning in the man page.
>
>>   .TP
>>   .BR "\-force"
>>   don't terminate tc on errors in batch mode.
>> -- 
>> 2.14.3
>>
diff mbox series

Patch

diff --git a/man/man8/tc.8 b/man/man8/tc.8
index ff071b33..de137e16 100644
--- a/man/man8/tc.8
+++ b/man/man8/tc.8
@@ -601,6 +601,11 @@  must exist already.
 read commands from provided file or standard input and invoke them.
 First failure will cause termination of tc.
 
+.TP
+.BR "\-bs", " \-bs size", " \-batchsize", " \-batchsize size"
+How many commands are accumulated before sending to kernel.
+By default, it is 1. It only takes effect in batch mode.
+
 .TP
 .BR "\-force"
 don't terminate tc on errors in batch mode.