[ovs-dev] docs: Fix cross-references that referred to discussions that have moved.

Message ID 20181109053900.28695-1-blp@ovn.org
State New
Headers show
Series
  • [ovs-dev] docs: Fix cross-references that referred to discussions that have moved.
Related show

Commit Message

Ben Pfaff Nov. 9, 2018, 5:39 a.m.
Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 include/openvswitch/meta-flow.h |  4 ++--
 ovn/utilities/ovn-sbctl.8.in    |  2 +-
 ovn/utilities/ovn-trace.8.xml   |  2 +-
 vswitchd/vswitch.xml            | 10 +++++-----
 4 files changed, 9 insertions(+), 9 deletions(-)

Comments

Yifeng Sun Nov. 12, 2018, 5:58 p.m. | #1
Looks good to me, thanks.

Reviewed-by: Yifeng Sun <pkusunyifeng@gmail.com>

On Thu, Nov 8, 2018 at 9:39 PM Ben Pfaff <blp@ovn.org> wrote:

> Signed-off-by: Ben Pfaff <blp@ovn.org>
> ---
>  include/openvswitch/meta-flow.h |  4 ++--
>  ovn/utilities/ovn-sbctl.8.in    |  2 +-
>  ovn/utilities/ovn-trace.8.xml   |  2 +-
>  vswitchd/vswitch.xml            | 10 +++++-----
>  4 files changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/include/openvswitch/meta-flow.h
> b/include/openvswitch/meta-flow.h
> index 152f512db3e8..ffd89452c36c 100644
> --- a/include/openvswitch/meta-flow.h
> +++ b/include/openvswitch/meta-flow.h
> @@ -136,7 +136,7 @@ struct ofputil_tlv_table_mod;
>   *       tunnel flags: Any number of the strings "df", "csum", "key", or
>   *         "oam" separated by "|".
>   *
> - *       TCP flags: See the description of tcp_flags in ovs-ofctl(8).
> + *       TCP flags: See the description of tcp_flags in ovs-fields(7).
>   *
>   *       packet type: A pair of packet type namespace NS and NS_TYPE
> within
>   *       that namespace "(NS,NS_TYPE)". NS and NS_TYPE are formatted in
> @@ -274,7 +274,7 @@ enum OVS_PACKED_ENUM mf_field_id {
>
>      /* "conj_id".
>       *
> -     * ID for "conjunction" actions.  Please refer to ovs-ofctl(8)
> +     * ID for "conjunction" actions.  Please refer to ovs-fields(7)
>       * documentation of "conjunction" for details.
>       *
>       * Type: be32.
> diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in
> index 659b44d70be4..2aaa457e826b 100644
> --- a/ovn/utilities/ovn-sbctl.8.in
> +++ b/ovn/utilities/ovn-sbctl.8.in
> @@ -182,7 +182,7 @@ display the OpenFlow flows that correspond to each OVN
> logical flow.
>  To do so, \fBovn\-sbctl\fR connects to \fIremote\fR (by default,
>  \fBunix:@RUNDIR@/br-int.mgmt\fR) over OpenFlow and retrieves the
>  flows.  If \fIremote\fR is specified, it must be an active OpenFlow
> -connection method described in \fBovs\-ofctl\fR(8).  Please see the
> +connection method described in \fBovsdb\fR(7).  Please see the
>  discussion of the similar \fB\-\-ovs\fR option in \fBovn-trace\fR(8)
>  for more information about the OpenFlow flow output.
>  .IP
> diff --git a/ovn/utilities/ovn-trace.8.xml b/ovn/utilities/ovn-trace.8.xml
> index d5e493e0eaed..01e74111901b 100644
> --- a/ovn/utilities/ovn-trace.8.xml
> +++ b/ovn/utilities/ovn-trace.8.xml
> @@ -330,7 +330,7 @@
>          <code>ovn-trace</code> connects to <var>remote</var> (by default,
>          <code>unix:@RUNDIR@/br-int.mgmt</code>) over OpenFlow and
> retrieves the
>          flows.  If <var>remote</var> is specified, it must be an active
> -        OpenFlow connection method described in <code>ovs-ofctl</code>(8).
> +        OpenFlow connection method described in <code>ovsdb</code>(7).
>        </p>
>
>        <p>
> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
> index efa1ef85e65e..170e843f1280 100644
> --- a/vswitchd/vswitch.xml
> +++ b/vswitchd/vswitch.xml
> @@ -2519,9 +2519,9 @@
>            <li>
>              The word <code>flow</code>.  The tunnel accepts packets with
> any
>              key.  The key will be placed in the <code>tun_id</code> field
> for
> -            matching in the flow table.  The <code>ovs-ofctl</code>
> manual page
> -            contains additional information about matching fields in
> OpenFlow
> -            flows.
> +            matching in the flow table.  The <code>ovs-fields</code>(7)
> manual
> +            page contains additional information about matching fields in
> +            OpenFlow flows.
>            </li>
>          </ul>
>
> @@ -2547,8 +2547,8 @@
>              The word <code>flow</code>.  Packets sent through the tunnel
> will
>              have the key set using the <code>set_tunnel</code> Nicira
> OpenFlow
>              vendor extension (0 is used in the absence of an action).  The
> -            <code>ovs-ofctl</code> manual page contains additional
> information
> -            about the Nicira OpenFlow vendor extensions.
> +            <code>ovs-fields</code>(7) manual page contains additional
> +            information about the Nicira OpenFlow vendor extensions.
>            </li>
>          </ul>
>        </column>
> --
> 2.16.1
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>

Patch

diff --git a/include/openvswitch/meta-flow.h b/include/openvswitch/meta-flow.h
index 152f512db3e8..ffd89452c36c 100644
--- a/include/openvswitch/meta-flow.h
+++ b/include/openvswitch/meta-flow.h
@@ -136,7 +136,7 @@  struct ofputil_tlv_table_mod;
  *       tunnel flags: Any number of the strings "df", "csum", "key", or
  *         "oam" separated by "|".
  *
- *       TCP flags: See the description of tcp_flags in ovs-ofctl(8).
+ *       TCP flags: See the description of tcp_flags in ovs-fields(7).
  *
  *       packet type: A pair of packet type namespace NS and NS_TYPE within
  *       that namespace "(NS,NS_TYPE)". NS and NS_TYPE are formatted in
@@ -274,7 +274,7 @@  enum OVS_PACKED_ENUM mf_field_id {
 
     /* "conj_id".
      *
-     * ID for "conjunction" actions.  Please refer to ovs-ofctl(8)
+     * ID for "conjunction" actions.  Please refer to ovs-fields(7)
      * documentation of "conjunction" for details.
      *
      * Type: be32.
diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in
index 659b44d70be4..2aaa457e826b 100644
--- a/ovn/utilities/ovn-sbctl.8.in
+++ b/ovn/utilities/ovn-sbctl.8.in
@@ -182,7 +182,7 @@  display the OpenFlow flows that correspond to each OVN logical flow.
 To do so, \fBovn\-sbctl\fR connects to \fIremote\fR (by default,
 \fBunix:@RUNDIR@/br-int.mgmt\fR) over OpenFlow and retrieves the
 flows.  If \fIremote\fR is specified, it must be an active OpenFlow
-connection method described in \fBovs\-ofctl\fR(8).  Please see the
+connection method described in \fBovsdb\fR(7).  Please see the
 discussion of the similar \fB\-\-ovs\fR option in \fBovn-trace\fR(8)
 for more information about the OpenFlow flow output.
 .IP
diff --git a/ovn/utilities/ovn-trace.8.xml b/ovn/utilities/ovn-trace.8.xml
index d5e493e0eaed..01e74111901b 100644
--- a/ovn/utilities/ovn-trace.8.xml
+++ b/ovn/utilities/ovn-trace.8.xml
@@ -330,7 +330,7 @@ 
         <code>ovn-trace</code> connects to <var>remote</var> (by default,
         <code>unix:@RUNDIR@/br-int.mgmt</code>) over OpenFlow and retrieves the
         flows.  If <var>remote</var> is specified, it must be an active
-        OpenFlow connection method described in <code>ovs-ofctl</code>(8).
+        OpenFlow connection method described in <code>ovsdb</code>(7).
       </p>
 
       <p>
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index efa1ef85e65e..170e843f1280 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2519,9 +2519,9 @@ 
           <li>
             The word <code>flow</code>.  The tunnel accepts packets with any
             key.  The key will be placed in the <code>tun_id</code> field for
-            matching in the flow table.  The <code>ovs-ofctl</code> manual page
-            contains additional information about matching fields in OpenFlow
-            flows.
+            matching in the flow table.  The <code>ovs-fields</code>(7) manual
+            page contains additional information about matching fields in
+            OpenFlow flows.
           </li>
         </ul>
 
@@ -2547,8 +2547,8 @@ 
             The word <code>flow</code>.  Packets sent through the tunnel will
             have the key set using the <code>set_tunnel</code> Nicira OpenFlow
             vendor extension (0 is used in the absence of an action).  The
-            <code>ovs-ofctl</code> manual page contains additional information
-            about the Nicira OpenFlow vendor extensions.
+            <code>ovs-fields</code>(7) manual page contains additional
+            information about the Nicira OpenFlow vendor extensions.
           </li>
         </ul>
       </column>