From: Vladimir Oltean <vladimir.oltean@nxp.com>
To: netdev@vger.kernel.org
Cc: David Ahern <dsahern@kernel.org>,
Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH iproute2-next 6/9] tc/mqprio: use words in man page to express min_rate/max_rate dependency on bw_rlimit
Date: Mon, 3 Apr 2023 13:52:42 +0300 [thread overview]
Message-ID: <20230403105245.2902376-7-vladimir.oltean@nxp.com> (raw)
In-Reply-To: <20230403105245.2902376-1-vladimir.oltean@nxp.com>
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>
---
man/man8/tc-mqprio.8 | 19 +++++++++++++------
1 file changed, 13 insertions(+), 6 deletions(-)
diff --git a/man/man8/tc-mqprio.8 b/man/man8/tc-mqprio.8
index 51c5644c36bd..e17c50621af0 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
--
2.34.1
next prev parent reply other threads:[~2023-04-03 10:53 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-03 10:52 [PATCH iproute2-next 0/9] Add tc-mqprio and tc-taprio support for preemptible traffic classes Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 1/9] uapi: add definitions for preemptible traffic classes in mqprio and taprio Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 2/9] utils: add max() definition Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 3/9] tc/taprio: add max-sdu to the man page SYNOPSIS section Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 4/9] tc/taprio: add a size table to the examples from the man page Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 5/9] tc/mqprio: fix stray ] in man page synopsis Vladimir Oltean
2023-04-03 10:52 ` Vladimir Oltean [this message]
2023-04-03 10:52 ` [PATCH iproute2-next 7/9] tc/mqprio: break up synopsis into multiple lines Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 8/9] tc/mqprio: add support for preemptible traffic classes Vladimir Oltean
2023-04-03 10:52 ` [PATCH iproute2-next 9/9] tc/taprio: " Vladimir Oltean
2023-04-03 11:18 ` [PATCH iproute2-next 0/9] Add tc-mqprio and tc-taprio " Ferenc Fejes
2023-04-03 11:23 ` Vladimir Oltean
2023-04-03 11:30 ` Ferenc Fejes
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230403105245.2902376-7-vladimir.oltean@nxp.com \
--to=vladimir.oltean@nxp.com \
--cc=dsahern@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=stephen@networkplumber.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.