From: Thomas Monjalon <thomas@monjalon.net>
To: john.mcnamara@intel.com, marko.kovacevic@intel.com,
shahafs@mellanox.com, yskoh@mellanox.com,
Tomasz Duszynski <tdu@semihalf.com>,
Dmitri Epshtein <dima@marvell.com>,
Natalie Samsonov <nsamsono@marvell.com>,
Adrien Mazarguil <adrien.mazarguil@6wind.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH 1/3] doc: remove useless anchor for flow API guide
Date: Wed, 30 Jan 2019 12:20:18 +0100 [thread overview]
Message-ID: <20190130112020.871-2-thomas@monjalon.net> (raw)
In-Reply-To: <20190130112020.871-1-thomas@monjalon.net>
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 --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.**
--
2.20.1
next prev parent reply other threads:[~2019-01-30 11:20 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-30 11:20 [dpdk-dev] [PATCH 0/3] more doc about isolated mode and bifurcated model Thomas Monjalon
2019-01-30 11:20 ` Thomas Monjalon [this message]
2019-01-30 11:20 ` [dpdk-dev] [PATCH 2/3] doc: add references to flow isolated mode in NICs guide Thomas Monjalon
2019-01-30 11:20 ` [dpdk-dev] [PATCH 3/3] doc: improve Mellanox bifurcated model description Thomas Monjalon
2019-01-31 6:58 ` [dpdk-dev] [PATCH 0/3] more doc about isolated mode and bifurcated model Shahaf Shuler
2019-01-31 17:36 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190130112020.871-2-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=adrien.mazarguil@6wind.com \
--cc=dev@dpdk.org \
--cc=dima@marvell.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=nsamsono@marvell.com \
--cc=shahafs@mellanox.com \
--cc=tdu@semihalf.com \
--cc=yskoh@mellanox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).