diff mbox series

[1/3] doc: remove useless anchor for flow API guide

Message ID 20190130112020.871-2-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series more doc about isolated mode and bifurcated model |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon Jan. 30, 2019, 11:20 a.m. UTC 
  A doc page (.rst file) can be referenced with :doc: syntax
instead of :ref: to .. anchor.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/howto/rte_flow.rst          | 2 +-
 doc/guides/nics/mvpp2.rst              | 2 +-
 doc/guides/prog_guide/rte_flow.rst     | 2 --
 doc/guides/rel_notes/release_17_02.rst | 3 +--
 4 files changed, 3 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/doc/guides/howto/rte_flow.rst b/doc/guides/howto/rte_flow.rst
index 6a8534d98..3dcda6cb1 100644
--- a/doc/guides/howto/rte_flow.rst
+++ b/doc/guides/howto/rte_flow.rst
@@ -8,7 +8,7 @@  This document demonstrates some concrete examples for programming flow rules
 with the ``rte_flow`` APIs.
 
 * Detail of the rte_flow APIs can be found in the following link:
-  :ref:`Generic flow API <Generic_flow_API>` .
+  :doc:`../prog_guide/rte_flow`.
 
 * Details of the TestPMD commands to set the flow rules can be found in the
   following link: :ref:`TestPMD Flow rules <testpmd_rte_flow>`
diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst
index b2ddeab50..9dcb93dd9 100644
--- a/doc/guides/nics/mvpp2.rst
+++ b/doc/guides/nics/mvpp2.rst
@@ -410,7 +410,7 @@  Flow API
 
 PPv2 offers packet classification capabilities via classifier engine which
 can be configured via generic flow API offered by DPDK.
-For an additional description please refer to DPDK :ref:`Generic flow API <Generic_flow_API>`.
+For an additional description please refer to DPDK :doc:`../prog_guide/rte_flow`.
 
 Supported flow actions
 ~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index dbf4999aa..472dcef47 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2,8 +2,6 @@ 
     Copyright 2016 6WIND S.A.
     Copyright 2016 Mellanox Technologies, Ltd
 
-.. _Generic_flow_API:
-
 Generic flow API (rte_flow)
 ===========================
 
diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst
index d6c1c5670..2244d27f9 100644
--- a/doc/guides/rel_notes/release_17_02.rst
+++ b/doc/guides/rel_notes/release_17_02.rst
@@ -77,8 +77,7 @@  New Features
   higher-level than the legacy filtering framework, which it encompasses and
   supersedes (including all functions and filter types) .
 
-  See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
-  information.
+  See the :doc:`../prog_guide/rte_flow` documentation for more information.
 
 * **Added firmware version get API.**