[ovs-dev] [PATCH 2/9] Fix ovs-ofctl documentation.

[Jarno Rajahalme]

Make it clear that match fields are rejected when their prerequisities
are not met, rather than just having their values ignored.

Also state that if decrementing makes a TTL zero, the controller
notification may be sent.

Signed-off-by: Jarno Rajahalme <jrajahalme at nicira.com>
---
 utilities/ovs-ofctl.8.in |   30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index b2bc8d7..0a2ddf6 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -590,7 +590,7 @@ When \fBdl_type=0x8035\fR or \fBrarp\fR is specified, matches the
 IPv4 and Ethernet.
 .IP
 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800,
-0x0806, or 0x8035, the values of \fBnw_src\fR and \fBnw_dst\fR are ignored
+0x0806, or 0x8035, \fBnw_src\fR and \fBnw_dst\fR are rejected
 (see \fBFlow Syntax\fR above).
 .
 .IP \fBnw_proto=\fIproto\fR
@@ -614,7 +614,7 @@ When \fBrarp\fR or \fBdl_type=0x8035\fR is specified, matches the lower
 0.
 .IP
 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800,
-0x0806, 0x8035 or 0x86dd, the value of \fBnw_proto\fR is ignored (see
+0x0806, 0x8035 or 0x86dd, \fBnw_proto\fR is rejected (see
 \fBFlow Syntax\fR above).
 .
 .IP \fBnw_tos=\fItos\fR
@@ -623,24 +623,21 @@ specified as a decimal number between 0 and 255, inclusive.  Note that
 the two lower reserved bits are ignored for matching purposes.
 .IP
 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
-0x86dd, the value of \fBnw_tos\fR is ignored (see \fBFlow Syntax\fR
-above).
+0x86dd, \fBnw_tos\fR is rejected (see \fBFlow Syntax\fR above).
 .
 .IP \fBnw_ecn=\fIecn\fR
 Matches \fIecn\fR bits in IP ToS or IPv6 traffic class fields, which is
 specified as a decimal number between 0 and 3, inclusive.
 .IP
 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
-0x86dd, the value of \fBnw_ecn\fR is ignored (see \fBFlow Syntax\fR
-above).
+0x86dd, \fBnw_ecn\fR is rejected (see \fBFlow Syntax\fR above).
 .
 .IP \fBnw_ttl=\fIttl\fR
 Matches IP TTL or IPv6 hop limit value \fIttl\fR, which is
 specified as a decimal number between 0 and 255, inclusive.
 .IP
 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
-0x86dd, the value of \fBnw_ttl\fR is ignored (see \fBFlow Syntax\fR
-above).
+0x86dd, \fBnw_ttl\fR is rejected (see \fBFlow Syntax\fR above).
 .IP
 .
 .IP \fBtp_src=\fIport\fR
@@ -651,8 +648,8 @@ and \fBtp_dst\fR match the UDP or TCP or SCTP source or destination port
 between 0 and 65535, inclusive (e.g. 80 to match packets originating
 from a HTTP server).
 .IP
-When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
-these settings are ignored (see \fBFlow Syntax\fR above).
+When \fBdl_type\fR and \fBnw_proto\fR take other values, these matches are
+rejected (see \fBFlow Syntax\fR above).
 .
 .IP \fBtp_src=\fIport\fB/\fImask\fR
 .IQ \fBtp_dst=\fIport\fB/\fImask\fR
@@ -722,8 +719,8 @@ When \fBdl_type\fR and \fBnw_proto\fR specify ICMP or ICMPv6, \fItype\fR
 matches the ICMP type and \fIcode\fR matches the ICMP code.  Each is
 specified as a decimal number between 0 and 255, inclusive.
 .IP
-When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
-these settings are ignored (see \fBFlow Syntax\fR above).
+When \fBdl_type\fR and \fBnw_proto\fR take other values, these matches
+are rejected (see \fBFlow Syntax\fR above).
 .
 .IP \fBtable=\fInumber\fR
 If specified, limits the flow manipulation and flow dump commands to
@@ -1142,7 +1139,8 @@ actions were applied.
 .IP \fBdec_ttl\fR
 .IQ \fBdec_ttl\fB[\fR(\fIid1,id2\fI)\fR]\fR
 Decrement TTL of IPv4 packet or hop limit of IPv6 packet.  If the
-TTL or hop limit is initially zero, no decrement occurs.  Instead,
+TTL or hop limit is initially zero or decrementing would make it so, no
+decrement occurs, as packets reaching TTL zero must be rejected.  Instead,
 a ``packet-in'' message with reason code \fBOFPR_INVALID_TTL\fR is
 sent to each connected controller that has enabled receiving them,
 if any.  Processing the current set of actions then stops.  However,
@@ -1161,9 +1159,9 @@ Set the TTL of the outer MPLS label stack entry of a packet.
 .
 .IP \fBdec_mpls_ttl\fR
 Decrement TTL of the outer MPLS label stack entry of a packet.  If the TTL
-is initially zero, no decrement occurs.  Instead, a ``packet-in'' message
-with reason code \fBOFPR_INVALID_TTL\fR is sent to each connected
-controller with controller id zer that has enabled receiving them.
+is initially zero or decrementing would make it so, no decrement occurs.
+Instead, a ``packet-in'' message with reason code \fBOFPR_INVALID_TTL\fR
+is sent to the main controller (id zero), if it has enabled receiving them.
 Processing the current set of actions then stops.  However, if the current
 set of actions was reached through ``resubmit'' then remaining actions in
 outer levels resume processing.
-- 
1.7.10.4