From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 32C4AA05D3 for ; Thu, 25 Apr 2019 17:42:08 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 237D81B5C4; Thu, 25 Apr 2019 17:42:08 +0200 (CEST) Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by dpdk.org (Postfix) with ESMTP id 86BB11B608 for ; Thu, 25 Apr 2019 17:42:06 +0200 (CEST) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id E3833309D047; Thu, 25 Apr 2019 15:42:05 +0000 (UTC) Received: from rh.redhat.com (unknown [10.36.116.255]) by smtp.corp.redhat.com (Postfix) with ESMTP id EC6845D9CD; Thu, 25 Apr 2019 15:42:04 +0000 (UTC) From: Kevin Traynor To: Dekel Peled Cc: dpdk stable Date: Thu, 25 Apr 2019 16:40:29 +0100 Message-Id: <20190425154037.28778-54-ktraynor@redhat.com> In-Reply-To: <20190425154037.28778-1-ktraynor@redhat.com> References: <20190425154037.28778-1-ktraynor@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.48]); Thu, 25 Apr 2019 15:42:06 +0000 (UTC) Subject: [dpdk-stable] patch 'doc: fix links to doxygen and sphinx sites' has been queued to LTS release 18.11.2 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 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 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 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 `_ 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. @@ -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 `_ Documentation Generator. +from RST markup text files using the `Sphinx `_ 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 `_. +For further information on getting started with Sphinx see the +`Sphinx Getting Started `_. .. 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 `_ 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.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@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