From: Alex Wang <al...@nicira.com> This patch Modifies the man page for the ofproto/trace command in accordance with the new implementation.
Signed-off-by: Alex Wang <al...@nicira.com> --- ofproto/ofproto-unixctl.man | 62 ++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 24 deletions(-) diff --git a/ofproto/ofproto-unixctl.man b/ofproto/ofproto-unixctl.man index 8890343..0dbd5f5 100644 --- a/ofproto/ofproto-unixctl.man +++ b/ofproto/ofproto-unixctl.man @@ -6,12 +6,18 @@ These commands manage the core OpenFlow switch implementation (called Lists the names of the running ofproto instances. These are the names that may be used on \fBofproto/trace\fR. . -.IP "\fBofproto/trace \fIswitch priority tun_id in_port mark packet\fR" -.IQ "\fBofproto/trace \fIswitch flow \fB\-generate\fR" -Traces the path of an imaginary packet through \fIswitch\fR. Both -forms require \fIswitch\fR, the switch on which the packet arrived -(one of those listed by \fBofproto/list\fR). The first form specifies -a packet's contents explicitly: +.IP "\fBofproto/trace\fR [\fIdatapath\fR] \fIpriority tun_id in_port \ +mark packet\fR" +.IQ "\fBofproto/trace\fR [\fIdatapath\fR] \fIdp_flow \fB\-generate\fR" +.IQ "\fBofproto/trace \fIswitch br_flow \fB\-generate\fR" +Traces the path of an imaginary packet through \fiswitch\fR. The first +two forms require an optional \fIdatapath\fR argument, which is the datapath +the \fiswitch\fR is on (can be found by \fBdpif/show\fR command). If more +than one datapath exists, the \fIdatapath\fR argument is compulsory. +The third form requires a \fIswitch\fR argument (one of those listed by +\fBofproto/list\fR). +.IP +The first form specifies a packet's contents explicitly: .RS .IP "\fIpriority\fR" Packet QoS priority. Use \fB0\fR if QoS is not setup. @@ -19,8 +25,8 @@ Packet QoS priority. Use \fB0\fR if QoS is not setup. The tunnel ID on which the packet arrived. Use \fB0\fR if the packet did not arrive through a tunnel. .IP "\fIin_port\fR" -The OpenFlow port on which the packet arrived. Use \fB65534\fR if the -packet arrived on \fBOFPP_LOCAL\fR, the local port. +The datapath port on which the packet arrived. The port mapping can +be found by \fBdpif/show\fR. .IP "\fImark\fR" SKB mark of the packet. Use \fB0\fR if Netfilter marks are not used. .IP "\fIpacket\fR" @@ -31,38 +37,46 @@ by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1) utilities provide easier ways. .RE .IP -The second form specifies the packet's contents implicitly: +The second and thrid form specify the packet's contents implicitly: .RS -.IP "\fIflow\fR" -A flow in one of two forms: either the form printed by -\fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format -similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR -command. This is not an OpenFlow flow: besides other differences, it -never contains wildcards. \fB\*(PN\fR generates an arbitrary packet -that has the specified \fIflow\fR. +.IP "\fIdp_flow\fR" +A flow in the form printed by \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR +command. \fB\*(PN\fR generates an arbitrary packet that has the specified +\fIdp_flow\fR. +.IP "\fIbr_flow\fR" +A flow in the form similar to that accepted by \fBovs\-ofctl\fR(8)'s +\fBadd\-flow\fR command. This is not an OpenFlow flow: besides other +differences, it never contains wildcards. \fB\*(PN\fR generates an +arbitrary packet that has the specified \fIbr_flow\fR. .RE .IP \fB\*(PN\fR will respond with extensive information on how the packet would be handled if it were to be received. The packet will not actually be sent, but side effects such as MAC learning will occur. . -.IP "\fBofproto/trace \fIswitch flow\fR" +.IP "\fBofproto/trace\fR [\fIdatapath\fR] \fIdp_flow\fR" +.IQ "\fBofproto/trace \fIswitch br_flow\fR" Traces the path of a packet in an imaginary flow through \fIswitch\fR. The arguments are: .RS +.IP "\fIdatapath\fR" +The \fIdatapath\fR of the switch on which the packet arrived (can be +found by \fBdpif/show\fR). If more than one datapath exists, the +\fIdatapath\fR argument is compulsory. +.IP "\fIdp_flow\fR" +A flow in the form printed by \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR +command. .IP "\fIswitch\fR" The switch on which the packet arrived (one of those listed by \fBofproto/list\fR). -.IP "\fIflow\fR" -A flow in one of two forms: either the form printed by -\fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format -similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR -command. This is not an OpenFlow flow: besides other differences, it -never contains wildcards. +.IP "\fIbr_flow\fR" +A flow in the form similar to that accepted by \fBovs\-ofctl\fR(8)'s +\fBadd\-flow\fR command. This is not an OpenFlow flow: besides other +differences, it never contains wildcards. .RE .IP \fB\*(PN\fR will respond with extensive information on how a packet -in \fIflow\fR would be handled if it were received by +in flow would be handled if it were received by \fIswitch\fR. No packet will actually be sent. Some side effects may occur, but MAC learning in particular will not. .IP -- 1.7.9.5 _______________________________________________ dev mailing list dev@openvswitch.org http://openvswitch.org/mailman/listinfo/dev
