[PATCH iproute2 0/2] netem: Fixes to man page

[PATCH iproute2 0/2] netem: Fixes to man page

[Vijay Subramanian]

These patches fix the netem man page. There were some errors not caught by spell
check and the text on reordering was incorrect. Please consider applying.

Thanks,


Vijay Subramanian (2):
  netem: Fix up grammatical errors in man page
  netem: Fix 'reorder' section of man page

 man/man8/tc-netem.8 |   32 ++++++++++++++++++++------------
 1 files changed, 20 insertions(+), 12 deletions(-)

[PATCH iproute2 1/2] netem: Fix up grammatical errors in man page

[Vijay Subramanian]

Signed-off-by: Vijay Subramanian <subramanian.vijay@gmail.com>
---
 man/man8/tc-netem.8 |   12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/man/man8/tc-netem.8 b/man/man8/tc-netem.8
index ff57624..b36d0ec 100644
--- a/man/man8/tc-netem.8
+++ b/man/man8/tc-netem.8
@@ -56,7 +56,7 @@ NetEm \- Network Emulator
 NetEm is an enhancement of the Linux traffic control facilities
 that allow to add delay, packet loss, duplication and more other
 characteristics to packets outgoing from a selected network
-interface. NetEm is build using the existing Quality Of Service (QOS)
+interface. NetEm is built using the existing Quality Of Service (QOS)
 and Differentiated Services (diffserv) facilities in the Linux
 kernel.
 
@@ -73,8 +73,8 @@ optional parameters allows to introduce a delay variation and a correlation.
 Delay and jitter values are expressed in ms while correlation is percentage.
 
 .SS distribution
-allow the choose the delay distribution. If not specified, the default
-distribution is normal. Additional parameters allow to consider situations in
+allow the user to choose the delay distribution. If not specified, the default
+distribution is Normal. Additional parameters allow to consider situations in
 which network has variable delays depending on traffic flows concurring on the
 same path, that causes several delay peaks and a tail.
 
@@ -85,7 +85,7 @@ is now deprecated due to the noticed bad behavior.
 
 .SS loss state
 adds packet losses according to the 4-state Markov using the transition
-probabilities as input parameters. The parameters p13 is mandatory and if used
+probabilities as input parameters. The parameter p13 is mandatory and if used
 alone corresponds to the Bernoulli model. The optional parameters allows to
 extend the model to 2-state (p31), 3-state (p23 and p32) and 4-state (p14).
 State 1 corresponds to good reception, State 4 to independent losses, State 3
@@ -94,7 +94,7 @@ to burst losses and State 2 to good reception within a burst.
 .SS loss gemodel
 adds packet losses according to the Gilbert-Elliot loss model or its special
 cases (Gilbert, Simple Gilbert and Bernoulli). To use the Bernoulli model, the
-only needed parameter is p while the the others will be set to the default
+only needed parameter is p while the others will be set to the default
 values r=1-p, 1-h=1 and 1-k=0. The parameters needed for the Simple Gilbert
 model are two (p and r), while three parameters (p, r, 1-h) are needed for the
 Gilbert model and four (p, r, 1-h and 1-k) are needed for the Gilbert-Elliot
@@ -103,7 +103,7 @@ the good states, 1-h is the loss probability in the bad state and 1-k is the
 loss probability in the good state.
 
 .SS corrupt
-allows the emulate the random noise introducing an error in a random position
+allows the emulation of random noise introducing an error in a random position
 for a chosen percent of packets. It is also possible to add a correlation
 through the proper parameter.
 
-- 
1.7.0.4

[PATCH iproute2 2/2] netem: Fix 'reorder' section of man page

[Vijay Subramanian]

The syntax used in the example on reordering in the manpage is inconsistent with
the usage syntax.  Moreover, the text does not describe the reordering process
in the kernel correctly. This patch fixes these two issues.

Signed-off-by: Vijay Subramanian <subramanian.vijay@gmail.com>
---
 man/man8/tc-netem.8 |   20 ++++++++++++++------
 1 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/man/man8/tc-netem.8 b/man/man8/tc-netem.8
index b36d0ec..39f8454 100644
--- a/man/man8/tc-netem.8
+++ b/man/man8/tc-netem.8
@@ -112,19 +112,27 @@ using this option the chosen percent of packets is duplicated before queuing
 them. It is also possible to add a correlation through the proper parameter.
 
 .SS reorder
-there are two ways to use this option:
+to use reordering, a delay option must be specified. There are two ways to use
+this option (assuming 'delay 10ms' in the options list).
 
-.B "reorder gap"
-.I 5 10
+.B "reorder "
+.I 25% 50%
+.B "gap"
+.I 5
 .br
-in this first example every 5th (10th, 15th) packet is sent immediately while
-other packets are delayed by 10 ms
+in this first example, the first 4 (gap - 1) packets are delayed by 10ms and
+subsequent packets are sent immediately with a probability of 0.25 (with
+correlation of 50% ) or delayed with a probability of 0.75. After a packet is
+reordered, the process restarts i.e. the next 4 packets are delayed and
+subsequent packets are sent immediately or delayed based on reordering
+probability. To cause a repeatable pattern where every 5th packet is reordered
+reliably, a reorder probability of 100% can be used.
 
 .B reorder
 .I 25% 50%
 .br
 in this second example 25% of packets are sent immediately (with correlation of
-50%) while the other are delayed by 10 ms.
+50%) while the others are delayed by 10 ms.
 
 .SS rate
 delay packets based on packet size and is a replacement for 
-- 
1.7.0.4