[dpdk-stable] patch 'doc: fix internal links for older releases' has been queued to LTS release 18.11.6

Kevin Traynor ktraynor at redhat.com
Wed Dec 11 22:26:18 CET 2019


Hi,

FYI, your patch has been queued to LTS release 18.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/17/19. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/5db3670442320ec560752157ac37e8336a9dee44

Thanks.

Kevin.

---
>From 5db3670442320ec560752157ac37e8336a9dee44 Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Tue, 8 Oct 2019 11:47:36 +0200
Subject: [PATCH] doc: fix internal links for older releases

[ upstream commit 43628b3df237069558ee5e6be417ae410b8ef6e1 ]

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")

Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Stephen Hemminger <stephen at networkplumber.org>
---
 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 3ca70bc05..837ed280e 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -8,5 +8,5 @@ QAT documentation consists of three parts:
 
 * Details of the symmetric crypto service 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
@@ -124,5 +124,5 @@ 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>`.
 
 
diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 3b4446ee9..07f9fde88 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -5,6 +5,5 @@ 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
@@ -22,5 +21,5 @@ 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
diff --git a/doc/guides/prog_guide/switch_representation.rst b/doc/guides/prog_guide/switch_representation.rst
index e5c78c234..cc1d0d756 100644
--- a/doc/guides/prog_guide/switch_representation.rst
+++ b/doc/guides/prog_guide/switch_representation.rst
@@ -349,6 +349,5 @@ 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)
@@ -737,6 +736,5 @@ 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
diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst
index a8cb6fbbe..793ed5537 100644
--- a/doc/guides/tools/testbbdev.rst
+++ b/doc/guides/tools/testbbdev.rst
@@ -63,6 +63,5 @@ 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``
-- 
2.21.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-12-11 21:24:14.775399535 +0000
+++ 0026-doc-fix-internal-links-for-older-releases.patch	2019-12-11 21:24:12.631651961 +0000
@@ -1 +1 @@
-From 43628b3df237069558ee5e6be417ae410b8ef6e1 Mon Sep 17 00:00:00 2001
+From 5db3670442320ec560752157ac37e8336a9dee44 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 43628b3df237069558ee5e6be417ae410b8ef6e1 ]
+
@@ -14 +15,0 @@
-Cc: stable at dpdk.org
@@ -26 +27 @@
-index 8630e2713..6197875fe 100644
+index 3ca70bc05..837ed280e 100644
@@ -31 +32 @@
- * Details of the symmetric and asymmetric crypto services below.
+ * Details of the symmetric crypto service below.
@@ -36 +37 @@
-@@ -159,5 +159,5 @@ Configuring and Building the DPDK QAT PMDs
+@@ -124,5 +124,5 @@ Configuring and Building the DPDK QAT PMDs
@@ -44 +45 @@
-index eb195ebd4..a95efbe0d 100644
+index 3b4446ee9..07f9fde88 100644
@@ -83 +84 @@
-index 7e6a4db2e..7e9569660 100644
+index a8cb6fbbe..793ed5537 100644



More information about the stable mailing list