Prepare for post-1.6.0 (1.6.90).

[openvswitch] / utilities / ovs-vlan-test.8.in

diff --git a/utilities/ovs-vlan-test.8.in b/utilities/ovs-vlan-test.8.in
index d3cd0316559943e72d59d22f5757d77c9713c66a..549dcad7829f65326d9b20c850ad5c0492dfe4df 100644 (file)
--- a/utilities/ovs-vlan-test.8.in
+++ b/utilities/ovs-vlan-test.8.in
@@ -8,6 +8,12 @@
 .so lib/common-syn.man
 .
 .SH DESCRIPTION
+The \fBovs\-vlan\-test\fR utility has some limitations, for example, it does
+not use TCP in its tests. Also it does not take into account MTU to detect
+potential edge cases. To overcome those limitations a new tool was
+developed \- \fBovs\-test\fR. \fBovs\-test\fR is currently supported only
+on Debian so, if possible try to use that on instead of \fBovs\-vlan\-test\fR.
+.PP
 The \fBovs\-vlan\-test\fR program may be used to check for problems sending
 802.1Q traffic which may occur when running Open vSwitch. These problems can
 occur when Open vSwitch is used to send 802.1Q traffic through physical
@@ -16,6 +22,9 @@ test, configure Open vSwitch to tag traffic originating from \fIvlan_ip\fR and
 forward it out the target interface. Then run the \fBovs\-vlan\-test\fR in
 client mode connecting to an \fBovs\-vlan\-test\fR server.
 \fBovs\-vlan\-test\fR will display "OK" if it did not detect problems.
+.PP
+Some examples of the types of problems that may be encountered are:
+.so utilities/ovs-vlan-bugs.man
 .
 .SS "Client Mode"
 An \fBovs\-vlan\-test\fR client may be run on a host to check for VLAN
@@ -58,19 +67,19 @@ Set up a bridge which forwards traffic originating from \fB1.2.3.4\fR out
 .IP
 .B \-\- set Interface vlan\-br\-tag type=internal
 .IP
-.B ifconfig vlan\-br\-tag up 5.6.7.8
+.B ifconfig vlan\-br\-tag up 1.2.3.4
 .
 .PP
 Run an \fBovs\-vlan\-test\fR server listening for client control traffic on
-5.6.7.8 port 80 and VLAN traffic on the default port of 1.2.3.0.
+172.16.0.142 port 8080 and VLAN traffic on the default port of 1.2.3.3.
 .IP
-.B ovs\-vlan\-test \-s 5.6.7.8:80 1.2.3.0
+.B ovs\-vlan\-test \-s 172.16.0.142:8080 1.2.3.3
 .
 .PP
-Run an \fBovs\-vlan\-test\fR client with a control server located at 5.6.7.8
-port 80 and a local VLAN ip of 1.2.3.4.
+Run an \fBovs\-vlan\-test\fR client with a control server located at
+172.16.0.142 port 8080 and a local VLAN ip of 1.2.3.4.
 .IP
-.B ovs\-vlan\-test 5.6.7.8:80 1.2.3.4
+.B ovs\-vlan\-test 172.16.0.142:8080 1.2.3.4
 .
 .TP
 
@@ -79,5 +88,6 @@ port 80 and a local VLAN ip of 1.2.3.4.
 .BR ovs\-vswitchd (8),
 .BR ovs\-ofctl (8),
 .BR ovs\-vsctl (8),
+.BR ovs\-test (8),
 .BR ethtool (8),
 .BR uname (1)