diff options
| author | Vladimir Oltean <vladimir.oltean@nxp.com> | 2023-04-18 14:39:47 +0300 |
|---|---|---|
| committer | Stephen Hemminger <stephen@networkplumber.org> | 2023-04-24 09:33:15 -0700 |
| commit | 82289b7addab7fed64d172806a8cebd8b2790693 (patch) | |
| tree | 92e4bd3a9c9d8cfe9a91e8374d75be798168561b | |
| parent | 4f4e2481e3a5fee64efeb7e8abeb8bb83eff8e7a (diff) | |
| download | iproute2-82289b7addab7fed64d172806a8cebd8b2790693.tar.gz | |
tc/mqprio: use words in man page to express min_rate/max_rate dependency on bw_rlimit
It is confusing and easy to get lost in the soup of brackets when trying
to explain that min_rate and max_rate are only accepted as optional
arguments when "shaper" takes the value "bw_rlimit".
Before (synopsis):
[ shaper dcb| [ bw_rlimit min_rate min_rate1 min_rate2 ... max_rate max_rate1 max_rate2 ... ]]
After (synopsis):
[ shaper dcb|bw_rlimit ] [ min_rate min_rate1 min_rate2 ... ] [ max_rate max_rate1 max_rate2 ... ]
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
| -rw-r--r-- | man/man8/tc-mqprio.8 | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/man/man8/tc-mqprio.8 b/man/man8/tc-mqprio.8 index 51c5644c..e17c5062 100644 --- a/man/man8/tc-mqprio.8 +++ b/man/man8/tc-mqprio.8 @@ -19,13 +19,12 @@ count1@offset1 count2@offset2 ... .B ] [ mode dcb|channel .B ] [ shaper -dcb| -.B [ bw_rlimit +dcb|bw_rlimit ] [ .B min_rate -min_rate1 min_rate2 ... +min_rate1 min_rate2 ... ] [ .B max_rate max_rate1 max_rate2 ... -.B ]] +.B ] .SH DESCRIPTION @@ -142,11 +141,19 @@ for hardware QOS defaults. Supported with 'hw' set to 1 only. .TP min_rate -Minimum value of bandwidth rate limit for a traffic class. +Minimum value of bandwidth rate limit for a traffic class. Supported only when +the +.B 'shaper' +argument is set to +.B 'bw_rlimit'. .TP max_rate -Maximum value of bandwidth rate limit for a traffic class. +Maximum value of bandwidth rate limit for a traffic class. Supported only when +the +.B 'shaper' +argument is set to +.B 'bw_rlimit'. .SH EXAMPLE |