Skip to content

Commit dca22a6

Browse files
mchehabJonathan Corbet
authored and
Jonathan Corbet
committed
docs-rst: add inter-document cross references
Add cross references for the development process documents that were converted to ReST: Documentation/SubmitChecklist Documentation/SubmittingDrivers Documentation/SubmittingPatches Documentation/development-process/development-process.rst Documentation/stable_kernel_rules.txt Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent 06ad636 commit dca22a6

File tree

5 files changed

+32
-18
lines changed

5 files changed

+32
-18
lines changed

Documentation/SubmitChecklist

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
.. _submitchecklist:
2+
13
Linux Kernel patch submission checklist
24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35

46
Here are some basic things that developers should do if they want to see their
57
kernel patch submissions accepted more quickly.
68

79
These are all above and beyond the documentation that is provided in
8-
Documentation/SubmittingPatches
10+
:ref:`Documentation/SubmittingPatches <submittingpatches>`
911
and elsewhere regarding submitting Linux kernel patches.
1012

1113

@@ -28,8 +30,8 @@ and elsewhere regarding submitting Linux kernel patches.
2830
4) ppc64 is a good architecture for cross-compilation checking because it
2931
tends to use ``unsigned long`` for 64-bit quantities.
3032

31-
5: Check your patch for general style as detailed in
32-
Documentation/CodingStyle.
33+
5) Check your patch for general style as detailed in
34+
:ref:`Documentation/CodingStyle <codingstyle>`.
3335
Check for trivial violations with the patch style checker prior to
3436
submission (``scripts/checkpatch.pl``).
3537
You should be able to justify all violations that remain in
@@ -54,7 +56,7 @@ and elsewhere regarding submitting Linux kernel patches.
5456
but any one function that uses more than 512 bytes on the stack is a
5557
candidate for change.
5658

57-
11: Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
59+
11) Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
5860
(Not required for static functions, but OK there also.) Use
5961
``make htmldocs`` or ``make pdfdocs`` to check the
6062
:ref:`kernel-doc <kernel_doc>` and fix any issues.

Documentation/SubmittingDrivers

+4-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Linux 2.4:
4040
maintainer does not respond or you cannot find the appropriate
4141
maintainer then please contact Willy Tarreau <w@1wt.eu>.
4242

43-
Linux 2.6:
43+
Linux 2.6 and upper:
4444
The same rules apply as 2.4 except that you should follow linux-kernel
45-
to track changes in API's. The final contact point for Linux 2.6
45+
to track changes in API's. The final contact point for Linux 2.6+
4646
submissions is Andrew Morton.
4747

4848
What Criteria Determine Acceptance
@@ -73,7 +73,8 @@ Interfaces:
7373

7474
Code:
7575
Please use the Linux style of code formatting as documented
76-
in Documentation/CodingStyle. If you have sections of code
76+
in :ref:`Documentation/CodingStyle <codingStyle>`.
77+
If you have sections of code
7778
that need to be in other formats, for example because they
7879
are shared with a windows driver kit and you want to
7980
maintain them just once separate them out nicely and note

Documentation/SubmittingPatches

+15-9
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ 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 Documentation/development-process. Also, read
14-
Documentation/SubmitChecklist for a list of items to check before
13+
works, see :ref:`Documentation/development-process <development_process_main>`.
14+
Also, read :ref:`Documentation/SubmitChecklist <submitchecklist>`
15+
for a list of items to check before
1516
submitting code. If you are submitting a driver, also read
16-
Documentation/SubmittingDrivers; for device tree binding patches, read
17+
:ref:`Documentation/SubmittingDrivers <submittingdrivers>`;
18+
for device tree binding patches, read
1719
Documentation/devicetree/bindings/submitting-patches.txt.
1820

1921
Many of these steps describe the default behavior of the ``git`` version
@@ -235,7 +237,9 @@ then only post say 15 or so at a time and wait for review and integration.
235237
---------------------------
236238

237239
Check your patch for basic style violations, details of which can be
238-
found in Documentation/CodingStyle. Failure to do so simply wastes
240+
found in
241+
:ref:`Documentation/CodingStyle <codingstyle>`.
242+
Failure to do so simply wastes
239243
the reviewers time and will get your patch rejected, probably
240244
without even being read.
241245

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

302306
into the sign-off area of your patch (note, NOT an email recipient). You
303-
should also read Documentation/stable_kernel_rules.txt in addition to this
304-
file.
307+
should also read
308+
:ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>`
309+
in addition to this file.
305310

306311
Note, however, that some subsystem maintainers want to come to their own
307312
conclusions on which patches should go to the stable trees. The networking
@@ -358,8 +363,9 @@ decreasing the likelihood of your MIME-attached change being accepted.
358363
Exception: If your mailer is mangling patches then someone may ask
359364
you to re-send them using MIME.
360365

361-
See Documentation/email-clients.txt for hints about configuring
362-
your e-mail client so that it sends your patches untouched.
366+
See :ref:`Documentation/email-clients.txt <email_clients>`
367+
for hints about configuring your e-mail client so that it sends your patches
368+
untouched.
363369

364370
7) E-mail size
365371
--------------
@@ -823,7 +829,7 @@ NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
823829
<https://lkml.org/lkml/2005/7/11/336>
824830

825831
Kernel Documentation/CodingStyle:
826-
<Documentation/CodingStyle>
832+
:ref:`Documentation/CodingStyle <codingstyle>`
827833

828834
Linus Torvalds's mail on the canonical patch format:
829835
<http://lkml.org/lkml/2005/4/7/183>

Documentation/development-process/development-process.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _development_process_main:
2+
13
A guide to the Kernel Development Process
24
=========================================
35

Documentation/stable_kernel_rules.txt

+5-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ Rules on what kind of patches are accepted, and which ones are not, into the
2626
race can be exploited is also provided.
2727
- It cannot contain any "trivial" fixes in it (spelling changes,
2828
whitespace cleanups, etc).
29-
- It must follow the Documentation/SubmittingPatches rules.
29+
- It must follow the
30+
:ref:`Documentation/SubmittingPatches <submittingpatches>`
31+
rules.
3032
- It or an equivalent fix must already exist in Linus' tree (upstream).
3133

3234

@@ -37,7 +39,8 @@ Procedure for submitting patches to the -stable tree
3739
submission guidelines as described in
3840
Documentation/networking/netdev-FAQ.txt
3941
- Security patches should not be handled (solely) by the -stable review
40-
process but should follow the procedures in Documentation/SecurityBugs.
42+
process but should follow the procedures in
43+
:ref:`Documentation/SecurityBugs <securitybugs>`.
4144

4245
For all other submissions, choose one of the following procedures
4346
-----------------------------------------------------------------

0 commit comments

Comments
 (0)