[dpdk-dev] doc: fix a link in contribution guide

Message ID 20170106012232.20246-1-yskoh@mellanox.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel compilation success Compilation OK

Commit Message

Yongseok Koh Jan. 6, 2017, 1:22 a.m. UTC
  A referenced document in the Linux Kernel has been moved to a
sub-directory.

Signed-off-by: Yongseok Koh <yskoh@mellanox.com>
---
 doc/guides/contributing/patches.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

John McNamara Jan. 6, 2017, 3:40 p.m. UTC | #1
> -----Original Message-----
> From: Yongseok Koh [mailto:yskoh@mellanox.com]
> Sent: Friday, January 6, 2017 1:23 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Yongseok Koh <yskoh@mellanox.com>
> Subject: [PATCH] doc: fix a link in contribution guide
> 
> A referenced document in the Linux Kernel has been moved to a sub-
> directory.
> 

Hi Yongseok,

Thanks for that. It is interesting to see kernel community move to RST/Sphinx.


> 
>  The DPDK development process is modelled (loosely) on the Linux Kernel
> development model so it is worth reading the  Linux kernel guide on
> submitting patches:
> -`How to Get Your Change Into the Linux Kernel 
> <http://www.kernel.org/doc/Documentation/SubmittingPatches>`_.
> +`How to Get Your Change Into the Linux Kernel
> <http://www.kernel.org/doc/Documentation/process/submitting-
> patches.rst>`_.


It would be better to use the Html rendered link here:

    https://www.kernel.org/doc/html/latest/process/submitting-patches.html


>  The rationale for many of the DPDK guidelines is explained in greater
> detail in the kernel guidelines.
> 
> 
> @@ -192,7 +192,7 @@ Here are some guidelines for the body of a commit
> message:
>        git commit --signoff # or -s
> 
>    The purpose of the signoff is explained in the
> -  `Developer's Certificate of Origin
> <http://www.kernel.org/doc/Documentation/SubmittingPatches>`_
> +  `Developer's Certificate of Origin
> + <http://www.kernel.org/doc/Documentation/process/submitting-patches.rs
> + t>`_

And here:

https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1

John
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index c7006c191..a6bae9172 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -7,7 +7,7 @@  This document outlines the guidelines for submitting code to DPDK.
 
 The DPDK development process is modelled (loosely) on the Linux Kernel development model so it is worth reading the
 Linux kernel guide on submitting patches:
-`How to Get Your Change Into the Linux Kernel <http://www.kernel.org/doc/Documentation/SubmittingPatches>`_.
+`How to Get Your Change Into the Linux Kernel <http://www.kernel.org/doc/Documentation/process/submitting-patches.rst>`_.
 The rationale for many of the DPDK guidelines is explained in greater detail in the kernel guidelines.
 
 
@@ -192,7 +192,7 @@  Here are some guidelines for the body of a commit message:
       git commit --signoff # or -s
 
   The purpose of the signoff is explained in the
-  `Developer's Certificate of Origin <http://www.kernel.org/doc/Documentation/SubmittingPatches>`_
+  `Developer's Certificate of Origin <http://www.kernel.org/doc/Documentation/process/submitting-patches.rst>`_
   section of the Linux kernel guidelines.
 
   .. Note::