netdev - [PATCH] tc-tbf.8: Add parameter range to man page.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:	Tue, 7 Aug 2012 10:30:32 +0800
From:	Li Wei <lw@...fujitsu.com>
To:	shemminger@...tta.com
Cc:	netdev@...r.kernel.org, Li Wei <lw@...fujitsu.com>
Subject: [PATCH] tc-tbf.8: Add parameter range to man page.

Signed-off-by: Li Wei <lw@...fujitsu.com>
---
 man/man8/tc-tbf.8 |    6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/man/man8/tc-tbf.8 b/man/man8/tc-tbf.8
index 3abb238..7b76146 100644
--- a/man/man8/tc-tbf.8
+++ b/man/man8/tc-tbf.8
@@ -76,6 +76,7 @@ latency parameter, which specifies the maximum amount of time a packet can
 sit in the TBF. The latter calculation takes into account the size of the
 bucket, the rate and possibly the peakrate (if set). These two parameters
 are mutually exclusive. 
+The range of parameter limit is [1, UINT32_MAX] bytes.
 .TP
 burst
 Also known as buffer or maxburst.
@@ -85,6 +86,7 @@ if you want to reach your configured rate!
 
 If your buffer is too small, packets may be dropped because more tokens arrive per timer tick than fit in your bucket.
 The minimum buffer size can be calculated by dividing the rate by HZ.
+The range of this parameter is [1, UINT32_MAX] bytes.
 
 Token usage calculations are performed using a table which by default has a resolution of 8 packets. 
 This resolution can be changed by specifying the 
@@ -96,11 +98,13 @@ this. Must be an integral power of 2.
 mpu
 A zero-sized packet does not use zero bandwidth. For ethernet, no packet uses less than 64 bytes. The Minimum Packet Unit 
 determines the minimal token usage (specified in bytes) for a packet. Defaults to zero.
+The range of this parameter is [0, UINT32_MAX] bytes.
 .TP
 rate
 The speed knob. See remarks above about limits! See 
 .BR tc (8)
 for units.
+The range of this parameter is [1, UINT32_MAX] bps.
 .PP
 Furthermore, if a peakrate is desired, the following parameters are available:
 
@@ -108,12 +112,14 @@ Furthermore, if a peakrate is desired, the following parameters are available:
 peakrate
 Maximum depletion rate of the bucket. Limited to 1mbit/s on Intel, 10mbit/s on Alpha. The peakrate does 
 not need to be set, it is only necessary if perfect millisecond timescale shaping is required.
+The range of this parameter is [1, UINT32_MAX] bps.
 
 .TP
 mtu/minburst
 Specifies the size of the peakrate bucket. For perfect accuracy, should be set to the MTU of the interface.
 If a peakrate is needed, but some burstiness is acceptable, this size can be raised. A 3000 byte minburst
 allows around 3mbit/s of peakrate, given 1000 byte packets.
+The range of this parameter is [1, UINT32_MAX] bytes.
 
 Like the regular burstsize you can also specify a 
 .B cell
-- 
1.7.10.1

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html