Document OVS packet buffering, to satisfy an OpenFlow 1.2+ requirement.

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

diff --git a/OPENFLOW-1.1+ b/OPENFLOW-1.1+
index 4bdd37e..4d69dfa 100644 (file)
--- a/OPENFLOW-1.1+
+++ b/OPENFLOW-1.1+
@@ -70,8 +70,6 @@ probably incomplete.
       implement it.  It should be implemented so that the default OVS
       behavior does not change.
 
-    * Document how OVS does packet buffering.
-
     * MPLS.  Simon Horman maintains a patch series that adds this
       feature.  This is partially merged.
 

diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
index 1606b87..58b5b93 100644 (file)
--- a/vswitchd/ovs-vswitchd.8.in
+++ b/vswitchd/ovs-vswitchd.8.in
@@ -211,6 +211,26 @@ enabled.
 .so lib/coverage-unixctl.man
 .so lib/stress-unixctl.man
 .
+.SH "OPENFLOW IMPLEMENTATION"
+.
+.PP
+This section documents aspects of OpenFlow for which the OpenFlow
+specification requires documentation.
+.
+.SS "Packet buffering."
+The OpenFlow specification, version 1.2, says:
+.
+.IP
+Switches that implement buffering are expected to expose, through
+documentation, both the amount of available buffering, and the length
+of time before buffers may be reused.
+.
+.PP
+Open vSwitch maintain a separate set of 256 packet buffers for each
+OpenFlow connection.  Any given packet buffer is preserved until it is
+referenced by an \fBOFPT_FLOW_MOD\fR or \fBOFPT_PACKET_OUT\fR request
+or for 5 seconds, whichever comes first.
+.
 .SH "LIMITS"
 .
 .PP