netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH iproute2 0/3] man: Updates for tc-htb.8
@ 2020-04-09  5:12 Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 1/3] man: tc-htb.8: add missing qdisc parameter r2q Benjamin Lee
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Benjamin Lee @ 2020-04-09  5:12 UTC (permalink / raw)
  To: netdev; +Cc: Benjamin Lee

Hello,

I'm new, so please let me know if this isn't the right place or format.

Here are a few minor updates for the tc-htb.8 man page.

Benjamin Lee (3):
  man: tc-htb.8: add missing qdisc parameter r2q
  man: tc-htb.8: add missing class parameter quantum
  man: tc-htb.8: fix class prio is not mandatory

 man/man8/tc-htb.8 | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

-- 
2.25.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH iproute2 1/3] man: tc-htb.8: add missing qdisc parameter r2q
  2020-04-09  5:12 [PATCH iproute2 0/3] man: Updates for tc-htb.8 Benjamin Lee
@ 2020-04-09  5:12 ` Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 2/3] man: tc-htb.8: add missing class parameter quantum Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 3/3] man: tc-htb.8: fix class prio is not mandatory Benjamin Lee
  2 siblings, 0 replies; 4+ messages in thread
From: Benjamin Lee @ 2020-04-09  5:12 UTC (permalink / raw)
  To: netdev; +Cc: Benjamin Lee

Add description for htb qdisc parameter r2q.

Signed-off-by: Benjamin Lee <ben@b1c1l1.com>
---
 man/man8/tc-htb.8 | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/man/man8/tc-htb.8 b/man/man8/tc-htb.8
index ae310f43..2bcb9c46 100644
--- a/man/man8/tc-htb.8
+++ b/man/man8/tc-htb.8
@@ -10,6 +10,8 @@ classid
 major:
 .B ] htb [ default
 minor-id
+.B ] [ r2q
+divisor
 .B ]
 
 .B tc class ... dev
@@ -93,6 +95,13 @@ will be generated within this qdisc.
 .TP
 default minor-id
 Unclassified traffic gets sent to the class with this minor-id.
+.TP
+r2q divisor
+Divisor used to calculate
+.B quantum
+values for classes.  Classes divide
+.B rate
+by this number.  Default value is 10.
 
 .SH CLASSES
 Classes have a host of parameters to configure their operation.
-- 
2.25.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH iproute2 2/3] man: tc-htb.8: add missing class parameter quantum
  2020-04-09  5:12 [PATCH iproute2 0/3] man: Updates for tc-htb.8 Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 1/3] man: tc-htb.8: add missing qdisc parameter r2q Benjamin Lee
@ 2020-04-09  5:12 ` Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 3/3] man: tc-htb.8: fix class prio is not mandatory Benjamin Lee
  2 siblings, 0 replies; 4+ messages in thread
From: Benjamin Lee @ 2020-04-09  5:12 UTC (permalink / raw)
  To: netdev; +Cc: Benjamin Lee

Add description for htb class parameter quantum.

Signed-off-by: Benjamin Lee <ben@b1c1l1.com>
---
 man/man8/tc-htb.8 | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/man/man8/tc-htb.8 b/man/man8/tc-htb.8
index 2bcb9c46..9accfecd 100644
--- a/man/man8/tc-htb.8
+++ b/man/man8/tc-htb.8
@@ -30,6 +30,8 @@ bytes
 bytes
 .B ] [ prio
 priority
+.B ] [ quantum
+bytes
 .B ]
 
 .SH DESCRIPTION
@@ -143,6 +145,17 @@ Amount of bytes that can be burst at 'infinite' speed, in other words, as fast
 as the interface can transmit them. For perfect evening out, should be equal to at most one average
 packet. Should be at least as high as the highest cburst of all children.
 
+.TP
+quantum bytes
+Number of bytes to serve from this class before the scheduler moves to the next class.
+Default value is
+.B rate
+divided by the qdisc
+.B r2q
+parameter.  If specified,
+.B r2q
+is ignored.
+
 .SH NOTES
 Due to Unix timing constraints, the maximum ceil rate is not infinite and may in fact be quite low. On Intel,
 there are 100 timer events per second, the maximum rate is that rate at which 'burst' bytes are sent each timer tick.
-- 
2.25.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH iproute2 3/3] man: tc-htb.8: fix class prio is not mandatory
  2020-04-09  5:12 [PATCH iproute2 0/3] man: Updates for tc-htb.8 Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 1/3] man: tc-htb.8: add missing qdisc parameter r2q Benjamin Lee
  2020-04-09  5:12 ` [PATCH iproute2 2/3] man: tc-htb.8: add missing class parameter quantum Benjamin Lee
@ 2020-04-09  5:12 ` Benjamin Lee
  2 siblings, 0 replies; 4+ messages in thread
From: Benjamin Lee @ 2020-04-09  5:12 UTC (permalink / raw)
  To: netdev; +Cc: Benjamin Lee

Fix description for htb class prio parameter to indicate it's not
mandatory.

Signed-off-by: Benjamin Lee <ben@b1c1l1.com>
---
 man/man8/tc-htb.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man8/tc-htb.8 b/man/man8/tc-htb.8
index 9accfecd..a4162342 100644
--- a/man/man8/tc-htb.8
+++ b/man/man8/tc-htb.8
@@ -120,7 +120,7 @@ class is going to have children.
 .TP
 prio priority
 In the round-robin process, classes with the lowest priority field are tried
-for packets first. Mandatory.
+for packets first.
 
 .TP
 rate rate
-- 
2.25.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-04-09  5:18 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-09  5:12 [PATCH iproute2 0/3] man: Updates for tc-htb.8 Benjamin Lee
2020-04-09  5:12 ` [PATCH iproute2 1/3] man: tc-htb.8: add missing qdisc parameter r2q Benjamin Lee
2020-04-09  5:12 ` [PATCH iproute2 2/3] man: tc-htb.8: add missing class parameter quantum Benjamin Lee
2020-04-09  5:12 ` [PATCH iproute2 3/3] man: tc-htb.8: fix class prio is not mandatory Benjamin Lee

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).