Commit 9912d0bb authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: process: submitting-patches.rst: avoid using ReST :doc:`foo` markup 



The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d172ab629c3e32c8d27ed4b9d2a209933e2a7178.1623824363.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent bffbae6d

Documentation/process/submitting-patches.rst

+15 −17
Original line number Diff line number Diff line
@@ -10,10 +10,11 @@ can greatly increase the chances of your change being accepted. 


This document contains a large number of suggestions in a relatively terse

format.  For detailed information on how the kernel development process

works, see :doc:`development-process`. Also, read :doc:`submit-checklist`

works, see Documentation/process/development-process.rst. Also, read

Documentation/process/submit-checklist.rst

for a list of items to check before submitting code.  If you are submitting

a driver, also read :doc:`submitting-drivers`; for device tree binding patches,

read :doc:`submitting-patches`.

a driver, also read Documentation/process/submitting-drivers.rst; for device

tree binding patches, read Documentation/process/submitting-patches.rst.



This documentation assumes that you're using ``git`` to prepare your patches.

If you're unfamiliar with ``git``, you would be well-advised to learn how to
@@ -178,8 +179,7 @@ Style-check your changes 
------------------------



Check your patch for basic style violations, details of which can be

found in

:ref:`Documentation/process/coding-style.rst <codingstyle>`.

found in Documentation/process/coding-style.rst.

Failure to do so simply wastes

the reviewers time and will get your patch rejected, probably

without even being read.
@@ -238,7 +238,7 @@ If you have a patch that fixes an exploitable security bug, send that patch 
to security@kernel.org.  For severe bugs, a short embargo may be considered

to allow distributors to get the patch out to users; in such cases,

obviously, the patch should not be sent to any public lists. See also

:doc:`/admin-guide/security-bugs`.

Documentation/admin-guide/security-bugs.rst.



Patches that fix a severe bug in a released kernel should be directed

toward the stable maintainers by putting a line like this::
@@ -246,9 +246,8 @@ toward the stable maintainers by putting a line like this:: 
  Cc: stable@vger.kernel.org



into the sign-off area of your patch (note, NOT an email recipient).  You

should also read

:ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`

in addition to this file.

should also read Documentation/process/stable-kernel-rules.rst

in addition to this document.



If changes affect userland-kernel interfaces, please send the MAN-PAGES

maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at
@@ -305,8 +304,8 @@ decreasing the likelihood of your MIME-attached change being accepted. 
Exception:  If your mailer is mangling patches then someone may ask

you to re-send them using MIME.



See :doc:`/process/email-clients` for hints about configuring your e-mail

client so that it sends your patches untouched.

See Documentation/process/email-clients.rst for hints about configuring

your e-mail client so that it sends your patches untouched.



Respond to review comments

--------------------------
@@ -324,7 +323,7 @@ for their time. Code review is a tiring and time-consuming process, and 
reviewers sometimes get grumpy.  Even in that case, though, respond

politely and address the problems they have pointed out.



See :doc:`email-clients` for recommendations on email

See Documentation/process/email-clients.rst for recommendations on email

clients and mailing list etiquette.
@@ -564,7 +563,7 @@ for more details. 
Note: Attaching a Fixes: tag does not subvert the stable kernel rules

process nor the requirement to Cc: stable@vger.kernel.org on all stable

patch candidates. For more information, please read

:ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`

Documentation/process/stable-kernel-rules.rst.



.. _the_canonical_patch_format:
@@ -824,8 +823,7 @@ Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer". 
NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!

  <https://lore.kernel.org/r/20050711.125305.08322243.davem@davemloft.net>



Kernel Documentation/process/coding-style.rst:

  :ref:`Documentation/process/coding-style.rst <codingstyle>`

Kernel Documentation/process/coding-style.rst



Linus Torvalds's mail on the canonical patch format:

  <https://lore.kernel.org/r/Pine.LNX.4.58.0504071023190.28951@ppc970.osdl.org>