doc: fix internal links for older releases
Checks
Commit Message
Using external explicit references to http://doc.dpdk.org makes older
releases documentation point to the current master documentation pages.
Switch to internal references.
Fixes: 59ad25fe2184 ("doc: add overview of qat guide")
Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Fixes: b7f859c9a9a5 ("doc: add switch representation documentation")
Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
Cc: stable@dpdk.org
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/cryptodevs/qat.rst | 4 ++--
doc/guides/prog_guide/event_timer_adapter.rst | 5 ++---
doc/guides/prog_guide/switch_representation.rst | 6 ++----
doc/guides/tools/testbbdev.rst | 3 +--
4 files changed, 7 insertions(+), 11 deletions(-)
Comments
On Tue, 8 Oct 2019 11:47:36 +0200
David Marchand <david.marchand@redhat.com> wrote:
> Using external explicit references to http://doc.dpdk.org makes older
> releases documentation point to the current master documentation pages.
> Switch to internal references.
>
> Fixes: 59ad25fe2184 ("doc: add overview of qat guide")
> Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
> Fixes: b7f859c9a9a5 ("doc: add switch representation documentation")
> Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
Looks good all references should be internal if possible.
Acked-by: Stephen Hemminger <stephen@networkplumber.org>
On Thu, Oct 10, 2019 at 12:57 AM Stephen Hemminger
<stephen@networkplumber.org> wrote:
> On Tue, 8 Oct 2019 11:47:36 +0200
> David Marchand <david.marchand@redhat.com> wrote:
>
> > Using external explicit references to http://doc.dpdk.org makes older
> > releases documentation point to the current master documentation pages.
> > Switch to internal references.
> >
> > Fixes: 59ad25fe2184 ("doc: add overview of qat guide")
> > Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
> > Fixes: b7f859c9a9a5 ("doc: add switch representation documentation")
> > Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
>
> Looks good all references should be internal if possible.
>
> Acked-by: Stephen Hemminger <stephen@networkplumber.org>
Applied, thanks.
@@ -7,7 +7,7 @@ Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
QAT documentation consists of three parts:
* Details of the symmetric and asymmetric crypto services below.
-* Details of the `compression service <http://doc.dpdk.org/guides/compressdevs/qat_comp.html>`_
+* Details of the :doc:`compression service <../compressdevs/qat_comp>`
in the compressdev drivers section.
* Details of building the common QAT infrastructure and the PMDs to support the
above services. See :ref:`building_qat` below.
@@ -146,7 +146,7 @@ Configuring and Building the DPDK QAT PMDs
Further information on configuring, building and installing DPDK is described
-`here <http://doc.dpdk.org/guides/linux_gsg/build_dpdk.html>`_.
+:doc:`here <../linux_gsg/build_dpdk>`.
Quick instructions for QAT cryptodev PMD are as follows:
@@ -4,8 +4,7 @@
Event Timer Adapter Library
===========================
-The DPDK
-`Event Device library <http://doc.dpdk.org/guides/prog_guide/eventdev.html>`_
+The DPDK :doc:`Event Device library <eventdev>`
introduces an event driven programming model which presents applications with
an alternative to the polling model traditionally used in DPDK
applications. Event devices can be coupled with arbitrary components to provide
@@ -21,7 +20,7 @@ The Event Timer Adapter library is designed to interface with hardware or
software implementations of the timer mechanism; it will query an eventdev PMD
to determine which implementation should be used. The default software
implementation manages timers using the DPDK
-`Timer library <http://doc.dpdk.org/guides/prog_guide/timer_lib.html>`_.
+:doc:`Timer library <timer_lib>`.
Examples of using the API are presented in the `API Overview`_ and
`Processing Timer Expiry Events`_ sections. Code samples are abstracted and
@@ -348,8 +348,7 @@ these endpoints provides a standard interface to manage their
interconnection without introducing new concepts and whole new API to
implement them. This is described in `flow API (rte_flow)`_.
-.. [6] `Generic flow API (rte_flow)
- <http://doc.dpdk.org/guides/prog_guide/rte_flow.html>`_
+.. [6] :doc:`Generic flow API (rte_flow) <rte_flow>`
Flow API (rte_flow)
-------------------
@@ -736,8 +735,7 @@ respective representors (**B** and **C**) if supported.
Examples in subsequent sections apply to hypervisor applications only and
are based on port representors **A**, **B** and **C**.
-.. [2] `Flow syntax
- <http://doc.dpdk.org/guides/testpmd_app_ug/testpmd_funcs.html#flow-syntax>`_
+.. [2] :ref:`Flow syntax <testpmd_rte_flow>`
Associating VF 1 with Physical Port 0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,8 +62,7 @@ The following are the command-line options:
``-e EAL_PARAMS, --eal_params EAL_PARAMS``
Specifies EAL arguments which are passed to the test app. For more details,
- refer to DPDK documentation at
- http://doc.dpdk.org/guides/linux_gsg/linux_eal_parameters.html.
+ refer to DPDK documentation at :doc:`../linux_gsg/linux_eal_parameters`.
``-t TIMEOUT, --timeout TIMEOUT``
Specifies timeout in seconds. If not specified timeout is set to 300 seconds.