[dpdk-stable] patch 'doc: fix links to doxygen and sphinx sites' has been queued to LTS release 18.11.2

Kevin Traynor ktraynor at redhat.com
Thu Apr 25 17:40:29 CEST 2019


Hi,

FYI, your patch has been queued to LTS release 18.11.2

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/01/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 can be viewed on the 18.11 branch at:
	https://github.com/kevintraynor/dpdk-stable-queue.git

Thanks.

Kevin Traynor

---
>From 0702b4e40fbefadea2390c82a2042104ec5b1bcd Mon Sep 17 00:00:00 2001
From: Dekel Peled <dekelp at mellanox.com>
Date: Wed, 3 Apr 2019 14:04:11 +0300
Subject: [PATCH] doc: fix links to doxygen and sphinx sites

[ upstream commit 047b663a5935b701fbc739e5a3fb142539519378 ]

Update broken links, replace with valid links.

Fixes: 7798f17a0d62 ("doc: add documentation guidelines")

Signed-off-by: Dekel Peled <dekelp at mellanox.com>
---
 doc/guides/contributing/documentation.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index c72280a29..408859e2c 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -41,5 +41,5 @@ The main directories that contain files related to documentation are shown below
 
 
-The API documentation is built from `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ comments in the header files.
+The API documentation is built from `Doxygen <http://www.doxygen.nl>`_ comments in the header files.
 These files are mainly in the ``lib/librte_*`` directories although some of the Poll Mode Drivers in ``drivers/net``
 are also documented with Doxygen.
@@ -48,5 +48,5 @@ The configuration files that are used to control the Doxygen output are in the `
 
 The user guides such as *The Programmers Guide* and the *FreeBSD* and *Linux Getting Started* Guides are generated
-from RST markup text files using the `Sphinx <http://sphinx-doc.org/index.html>`_ Documentation Generator.
+from RST markup text files using the `Sphinx <http://sphinx-doc.org>`_ Documentation Generator.
 
 These files are included in the ``doc/guides/`` directory.
@@ -175,5 +175,6 @@ For full support with figure and table captioning the latest version of Sphinx c
    sudo pip install --upgrade sphinx_rtd_theme
 
-For further information on getting started with Sphinx see the `Sphinx Tutorial <http://sphinx-doc.org/tutorial.html>`_.
+For further information on getting started with Sphinx see the
+`Sphinx Getting Started <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
 
 .. Note::
@@ -597,5 +598,5 @@ Doxygen Guidelines
 The DPDK API is documented using Doxygen comment annotations in the header files.
 Doxygen is a very powerful tool, it is extremely configurable and with a little effort can be used to create expressive documents.
-See the `Doxygen website <http://www.stack.nl/~dimitri/doxygen/>`_ for full details on how to use it.
+See the `Doxygen website <http://www.doxygen.nl>`_ for full details on how to use it.
 
 The following are some guidelines for use of Doxygen in the DPDK API documentation:
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-04-25 16:37:49.075657108 +0100
+++ 0054-doc-fix-links-to-doxygen-and-sphinx-sites.patch	2019-04-25 16:37:46.770294377 +0100
@@ -1 +1 @@
-From 047b663a5935b701fbc739e5a3fb142539519378 Mon Sep 17 00:00:00 2001
+From 0702b4e40fbefadea2390c82a2042104ec5b1bcd Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 047b663a5935b701fbc739e5a3fb142539519378 ]
+
@@ -9 +10,0 @@
-Cc: stable at dpdk.org
@@ -17 +18 @@
-index baf0921fb..9d381919b 100644
+index c72280a29..408859e2c 100644
@@ -20 +21 @@
-@@ -40,5 +40,5 @@ The main directories that contain files related to documentation are shown below
+@@ -41,5 +41,5 @@ The main directories that contain files related to documentation are shown below
@@ -27 +28 @@
-@@ -47,5 +47,5 @@ The configuration files that are used to control the Doxygen output are in the `
+@@ -48,5 +48,5 @@ The configuration files that are used to control the Doxygen output are in the `
@@ -34 +35 @@
-@@ -174,5 +174,6 @@ For full support with figure and table captioning the latest version of Sphinx c
+@@ -175,5 +175,6 @@ For full support with figure and table captioning the latest version of Sphinx c
@@ -42 +43 @@
-@@ -596,5 +597,5 @@ Doxygen Guidelines
+@@ -597,5 +598,5 @@ Doxygen Guidelines


More information about the stable mailing list