From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 08E22A046B for ; Tue, 23 Jul 2019 03:03:31 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id D8FB81BFC7; Tue, 23 Jul 2019 03:03:30 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id 9C2CC1BFA1 for ; Tue, 23 Jul 2019 03:03:29 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE2 (envelope-from yskoh@mellanox.com) with ESMTPS (AES256-SHA encrypted); 23 Jul 2019 04:03:24 +0300 Received: from scfae-sc-2.mti.labs.mlnx (scfae-sc-2.mti.labs.mlnx [10.101.0.96]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x6N11Hfv026580; Tue, 23 Jul 2019 04:03:23 +0300 From: Yongseok Koh To: Dekel Peled Cc: dpdk stable Date: Mon, 22 Jul 2019 18:00:38 -0700 Message-Id: <20190723010115.6446-71-yskoh@mellanox.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190723010115.6446-1-yskoh@mellanox.com> References: <20190723010115.6446-1-yskoh@mellanox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-stable] patch 'doc: fix links to doxygen and sphinx sites' has been queued to LTS release 17.11.7 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" Hi, FYI, your patch has been queued to LTS release 17.11.7 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objection by 07/27/19. So please shout if anyone has objection. 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. Thanks. Yongseok --- >From 37a027ac03795c7293effc026d9d21f78898654f Mon Sep 17 00:00:00 2001 From: Dekel Peled 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 --- 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 6ccca11a28..0a0c39013b 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -37,14 +37,14 @@ The main directories that contain files related to documentation are shown below |-- ... -The API documentation is built from `Doxygen `_ comments in the header files. +The API documentation is built from `Doxygen `_ 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. The configuration files that are used to control the Doxygen output are in the ``doc/api`` directory. 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 `_ Documentation Generator. +from RST markup text files using the `Sphinx `_ Documentation Generator. These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. @@ -171,7 +171,8 @@ For full support with figure and table captioning the latest version of Sphinx c sudo pip install --upgrade sphinx sudo pip install --upgrade sphinx_rtd_theme -For further information on getting started with Sphinx see the `Sphinx Tutorial `_. +For further information on getting started with Sphinx see the +`Sphinx Getting Started `_. .. Note:: @@ -593,7 +594,7 @@ 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 `_ for full details on how to use it. +See the `Doxygen website `_ for full details on how to use it. The following are some guidelines for use of Doxygen in the DPDK API documentation: -- 2.21.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2019-07-22 17:55:10.296568905 -0700 +++ 0071-doc-fix-links-to-doxygen-and-sphinx-sites.patch 2019-07-22 17:55:06.247477000 -0700 @@ -1,12 +1,13 @@ -From 047b663a5935b701fbc739e5a3fb142539519378 Mon Sep 17 00:00:00 2001 +From 37a027ac03795c7293effc026d9d21f78898654f Mon Sep 17 00:00:00 2001 From: Dekel Peled 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") -Cc: stable@dpdk.org Signed-off-by: Dekel Peled --- @@ -14,10 +15,10 @@ 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst -index baf0921fbd..9d381919b3 100644 +index 6ccca11a28..0a0c39013b 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst -@@ -39,14 +39,14 @@ The main directories that contain files related to documentation are shown below +@@ -37,14 +37,14 @@ The main directories that contain files related to documentation are shown below |-- ... @@ -34,7 +35,7 @@ These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. -@@ -173,7 +173,8 @@ For full support with figure and table captioning the latest version of Sphinx c +@@ -171,7 +171,8 @@ For full support with figure and table captioning the latest version of Sphinx c sudo pip install --upgrade sphinx sudo pip install --upgrade sphinx_rtd_theme @@ -44,7 +45,7 @@ .. Note:: -@@ -595,7 +596,7 @@ Doxygen Guidelines +@@ -593,7 +594,7 @@ 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.