From 43628b3df237069558ee5e6be417ae410b8ef6e1 Mon Sep 17 00:00:00 2001 From: David Marchand Date: Tue, 8 Oct 2019 11:47:36 +0200 Subject: [PATCH] doc: fix internal links for older releases 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 Acked-by: Stephen Hemminger --- 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(-) diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index 8630e27132..6197875fe3 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -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 `_ +* 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. @@ -158,7 +158,7 @@ Configuring and Building the DPDK QAT PMDs Further information on configuring, building and installing DPDK is described -`here `_. +:doc:`here <../linux_gsg/build_dpdk>`. Quick instructions for QAT cryptodev PMD are as follows: diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst index eb195ebd4c..a95efbe0d8 100644 --- a/doc/guides/prog_guide/event_timer_adapter.rst +++ b/doc/guides/prog_guide/event_timer_adapter.rst @@ -4,8 +4,7 @@ Event Timer Adapter Library =========================== -The DPDK -`Event Device library `_ +The DPDK :doc:`Event Device library ` 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 `_. +:doc:`Timer library `. Examples of using the API are presented in the `API Overview`_ and `Processing Timer Expiry Events`_ sections. Code samples are abstracted and diff --git a/doc/guides/prog_guide/switch_representation.rst b/doc/guides/prog_guide/switch_representation.rst index e5c78c2340..cc1d0d7569 100644 --- a/doc/guides/prog_guide/switch_representation.rst +++ b/doc/guides/prog_guide/switch_representation.rst @@ -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) - `_ +.. [6] :doc:`Generic flow API (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 - `_ +.. [2] :ref:`Flow syntax ` Associating VF 1 with Physical Port 0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index 7e6a4db2e0..7e95696609 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -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.