Skip to content

Commit 9912d0b

Browse files
mchehabJonathan Corbet
authored andcommitted
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: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/d172ab629c3e32c8d27ed4b9d2a209933e2a7178.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent bffbae6 commit 9912d0b

1 file changed

Lines changed: 15 additions & 17 deletions

File tree

Documentation/process/submitting-patches.rst

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ can greatly increase the chances of your change being accepted.
1010

1111
This document contains a large number of suggestions in a relatively terse
1212
format. For detailed information on how the kernel development process
13-
works, see :doc:`development-process`. Also, read :doc:`submit-checklist`
13+
works, see Documentation/process/development-process.rst. Also, read
14+
Documentation/process/submit-checklist.rst
1415
for a list of items to check before submitting code. If you are submitting
15-
a driver, also read :doc:`submitting-drivers`; for device tree binding patches,
16-
read :doc:`submitting-patches`.
16+
a driver, also read Documentation/process/submitting-drivers.rst; for device
17+
tree binding patches, read Documentation/process/submitting-patches.rst.
1718

1819
This documentation assumes that you're using ``git`` to prepare your patches.
1920
If you're unfamiliar with ``git``, you would be well-advised to learn how to
@@ -178,8 +179,7 @@ Style-check your changes
178179
------------------------
179180

180181
Check your patch for basic style violations, details of which can be
181-
found in
182-
:ref:`Documentation/process/coding-style.rst <codingstyle>`.
182+
found in Documentation/process/coding-style.rst.
183183
Failure to do so simply wastes
184184
the reviewers time and will get your patch rejected, probably
185185
without even being read.
@@ -238,17 +238,16 @@ If you have a patch that fixes an exploitable security bug, send that patch
238238
to security@kernel.org. For severe bugs, a short embargo may be considered
239239
to allow distributors to get the patch out to users; in such cases,
240240
obviously, the patch should not be sent to any public lists. See also
241-
:doc:`/admin-guide/security-bugs`.
241+
Documentation/admin-guide/security-bugs.rst.
242242

243243
Patches that fix a severe bug in a released kernel should be directed
244244
toward the stable maintainers by putting a line like this::
245245

246246
Cc: stable@vger.kernel.org
247247

248248
into the sign-off area of your patch (note, NOT an email recipient). You
249-
should also read
250-
:ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`
251-
in addition to this file.
249+
should also read Documentation/process/stable-kernel-rules.rst
250+
in addition to this document.
252251

253252
If changes affect userland-kernel interfaces, please send the MAN-PAGES
254253
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.
305304
Exception: If your mailer is mangling patches then someone may ask
306305
you to re-send them using MIME.
307306

308-
See :doc:`/process/email-clients` for hints about configuring your e-mail
309-
client so that it sends your patches untouched.
307+
See Documentation/process/email-clients.rst for hints about configuring
308+
your e-mail client so that it sends your patches untouched.
310309

311310
Respond to review comments
312311
--------------------------
@@ -324,7 +323,7 @@ for their time. Code review is a tiring and time-consuming process, and
324323
reviewers sometimes get grumpy. Even in that case, though, respond
325324
politely and address the problems they have pointed out.
326325

327-
See :doc:`email-clients` for recommendations on email
326+
See Documentation/process/email-clients.rst for recommendations on email
328327
clients and mailing list etiquette.
329328

330329

@@ -562,10 +561,10 @@ method for indicating a bug fixed by the patch. See :ref:`describe_changes`
562561
for more details.
563562

564563
Note: Attaching a Fixes: tag does not subvert the stable kernel rules
565-
process nor the requirement to Cc: stable@vger.kernel.org on all stable
564+
process nor the requirement to Cc: stable@vger.kernel.org on all stable
566565
patch candidates. For more information, please read
567-
:ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`
568-
566+
Documentation/process/stable-kernel-rules.rst.
567+
569568
.. _the_canonical_patch_format:
570569

571570
The canonical patch format
@@ -824,8 +823,7 @@ Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
824823
NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
825824
<https://lore.kernel.org/r/20050711.125305.08322243.davem@davemloft.net>
826825

827-
Kernel Documentation/process/coding-style.rst:
828-
:ref:`Documentation/process/coding-style.rst <codingstyle>`
826+
Kernel Documentation/process/coding-style.rst
829827

830828
Linus Torvalds's mail on the canonical patch format:
831829
<https://lore.kernel.org/r/Pine.LNX.4.58.0504071023190.28951@ppc970.osdl.org>

0 commit comments

Comments
 (0)