From: Ben Pfaff <blp@nicira.com>
Date: Sat, 17 Oct 2015 03:03:58 +0000 (-0700)
Subject: ovn-sb: Document "ip.ttl--;" action.
X-Git-Tag: v2.5.0~417
X-Git-Url: http://git.cascardo.eti.br/?a=commitdiff_plain;h=00ea19e49636e06edbd799d5e0255f507f1e7152;hp=c7e69808bdb4beb5df2f69b964d448487e775926;p=cascardo%2Fovs.git

ovn-sb: Document "ip.ttl--;" action.

This was implemented by commits a while back, but the documentation was
accidentally omitted.

Signed-off-by: Ben Pfaff <blp@nicira.com>
---

diff --git a/ovn/ovn-sb.xml b/ovn/ovn-sb.xml
index 5e9604b0b..3b9fb0bfd 100644
--- a/ovn/ovn-sb.xml
+++ b/ovn/ovn-sb.xml
@@ -857,6 +857,18 @@
           </p>
         </dd>
 
+        <dt><code>ip.ttl--;</code></dt>
+        <dd>
+          <p>
+            Decrements the IPv4 or IPv6 TTL.  If this would make the TTL zero
+            or negative, then processing of the packet halts; no further
+            actions are processed.  (To properly handle such cases, a
+            higher-priority flow should match on <code>ip.ttl &lt; 2</code>.)
+          </p>
+
+          <p><b>Prerequisite:</b> <code>ip</code></p>
+        </dd>
+
         <dt><code>ct_next;</code></dt>
         <dd>
           <p>
@@ -897,12 +909,6 @@
       <dl>
         <dt><code>learn</code></dt>
 
-        <dt><code>dec_ttl { <var>action</var>, </code>...<code> } { <var>action</var>; </code>...<code>};</code></dt>
-        <dd>
-          decrement TTL; execute first set of actions if
-          successful, second set if TTL decrement fails
-        </dd>
-
         <dt><code>icmp_reply { <var>action</var>, </code>...<code> };</code></dt>
         <dd>generate ICMP reply from packet, execute <var>action</var>s</dd>