netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Vijay Subramanian <subramanian.vijay@gmail.com>
To: netdev@vger.kernel.org
Cc: Stephen Hemminger <shemminger@vyatta.com>,
	Vijay Subramanian <subramanian.vijay@gmail.com>
Subject: [PATCH iproute2 2/2] netem: Fix 'reorder' section of man page
Date: Mon, 23 Jan 2012 22:08:52 -0800	[thread overview]
Message-ID: <1327385332-20776-3-git-send-email-subramanian.vijay@gmail.com> (raw)
In-Reply-To: <1327385332-20776-1-git-send-email-subramanian.vijay@gmail.com>

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

      parent reply	other threads:[~2012-01-24  6:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-01-24  6:08 [PATCH iproute2 0/2] netem: Fixes to man page Vijay Subramanian
2012-01-24  6:08 ` [PATCH iproute2 1/2] netem: Fix up grammatical errors in " Vijay Subramanian
2012-01-24  6:08 ` Vijay Subramanian [this message]

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=1327385332-20776-3-git-send-email-subramanian.vijay@gmail.com \
    --to=subramanian.vijay@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=shemminger@vyatta.com \
    /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 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).