diff mbox

[08/11] docs: Tweak submitting-patches.rst formatting

Message ID 1477523979-5837-9-git-send-email-corbet@lwn.net
State New
Headers show

Commit Message

Jonathan Corbet Oct. 26, 2016, 11:19 p.m. UTC
The main goal here was to get the subsections to show in the TOC as they do
for all the other documents.  Also call out the DCO in the section title
since it's important.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
 Documentation/process/submitting-patches.rst | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

-- 
2.7.4

Comments

Mauro Carvalho Chehab Oct. 27, 2016, 12:25 a.m. UTC | #1
Em Wed, 26 Oct 2016 17:19:36 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> The main goal here was to get the subsections to show in the TOC as they do

> for all the other documents.  Also call out the DCO in the section title

> since it's important.

> 

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>


Looks good to me.

Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>


> ---

>  Documentation/process/submitting-patches.rst | 16 ++++++----------

>  1 file changed, 6 insertions(+), 10 deletions(-)

> 

> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst

> index b4cf8f375184..3e10719fee35 100644

> --- a/Documentation/process/submitting-patches.rst

> +++ b/Documentation/process/submitting-patches.rst

> @@ -1,7 +1,7 @@

>  .. _submittingpatches:

>  

> -How to Get Your Change Into the Linux Kernel or Care And Operation Of Your Linus Torvalds

> -=========================================================================================

> +Submitting patches: the essential guide to getting your code into the kernel

> +============================================================================

>  

>  For a person or company who wishes to submit a change to the Linux

>  kernel, the process can sometimes be daunting if you're not familiar

> @@ -24,10 +24,6 @@ of the mechanical work done for you, though you'll still need to prepare

>  and document a sensible set of patches.  In general, use of ``git`` will make

>  your life as a kernel developer easier.

>  

> -Creating and Sending your Change

> -********************************

> -

> -

>  0) Obtain a current source tree

>  -------------------------------

>  

> @@ -417,8 +413,8 @@ e-mail discussions.

>  

>  

>  

> -11) Sign your work

> -------------------

> +11) Sign your work — the Developer's Certificate of Origin

> +----------------------------------------------------------

>  

>  To improve tracking of who did what, especially with patches that can

>  percolate to their final resting place in the kernel through several

> @@ -803,8 +799,8 @@ command like this will do the trick::

>    git request-pull master git://my.public.tree/linux.git my-signed-tag

>  

>  

> -REFERENCES

> -**********

> +References

> +----------

>  

>  Andrew Morton, "The perfect patch" (tpp).

>    <http://www.ozlabs.org/~akpm/stuff/tpp.txt>




Thanks,
Mauro
diff mbox

Patch

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index b4cf8f375184..3e10719fee35 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -1,7 +1,7 @@ 
 .. _submittingpatches:
 
-How to Get Your Change Into the Linux Kernel or Care And Operation Of Your Linus Torvalds
-=========================================================================================
+Submitting patches: the essential guide to getting your code into the kernel
+============================================================================
 
 For a person or company who wishes to submit a change to the Linux
 kernel, the process can sometimes be daunting if you're not familiar
@@ -24,10 +24,6 @@  of the mechanical work done for you, though you'll still need to prepare
 and document a sensible set of patches.  In general, use of ``git`` will make
 your life as a kernel developer easier.
 
-Creating and Sending your Change
-********************************
-
-
 0) Obtain a current source tree
 -------------------------------
 
@@ -417,8 +413,8 @@  e-mail discussions.
 
 
 
-11) Sign your work
-------------------
+11) Sign your work — the Developer's Certificate of Origin
+----------------------------------------------------------
 
 To improve tracking of who did what, especially with patches that can
 percolate to their final resting place in the kernel through several
@@ -803,8 +799,8 @@  command like this will do the trick::
   git request-pull master git://my.public.tree/linux.git my-signed-tag
 
 
-REFERENCES
-**********
+References
+----------
 
 Andrew Morton, "The perfect patch" (tpp).
   <http://www.ozlabs.org/~akpm/stuff/tpp.txt>