diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-21 07:51:05 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-09-21 17:43:09 -0400 |
commit | dca22a63fd036c3ebb50212060eba0080f178126 (patch) | |
tree | 5b916da6aca03344aab37c9e1922ed22e3471287 | |
parent | 06ad6367101c0ba65c863287468539e3d8c69ca3 (diff) |
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>
-rw-r--r-- | Documentation/SubmitChecklist | 10 | ||||
-rw-r--r-- | Documentation/SubmittingDrivers | 7 | ||||
-rw-r--r-- | Documentation/SubmittingPatches | 24 | ||||
-rw-r--r-- | Documentation/development-process/development-process.rst | 2 | ||||
-rw-r--r-- | Documentation/stable_kernel_rules.txt | 7 |
5 files changed, 32 insertions, 18 deletions
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist index 22a370ff34e5..894289b22b15 100644 --- a/Documentation/SubmitChecklist +++ b/Documentation/SubmitChecklist | |||
@@ -1,3 +1,5 @@ | |||
1 | .. _submitchecklist: | ||
2 | |||
1 | Linux Kernel patch submission checklist | 3 | Linux Kernel patch submission checklist |
2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
3 | 5 | ||
@@ -5,7 +7,7 @@ Here are some basic things that developers should do if they want to see their | |||
5 | kernel patch submissions accepted more quickly. | 7 | kernel patch submissions accepted more quickly. |
6 | 8 | ||
7 | These are all above and beyond the documentation that is provided in | 9 | These are all above and beyond the documentation that is provided in |
8 | Documentation/SubmittingPatches | 10 | :ref:`Documentation/SubmittingPatches <submittingpatches>` |
9 | and elsewhere regarding submitting Linux kernel patches. | 11 | and elsewhere regarding submitting Linux kernel patches. |
10 | 12 | ||
11 | 13 | ||
@@ -28,8 +30,8 @@ and elsewhere regarding submitting Linux kernel patches. | |||
28 | 4) ppc64 is a good architecture for cross-compilation checking because it | 30 | 4) ppc64 is a good architecture for cross-compilation checking because it |
29 | tends to use ``unsigned long`` for 64-bit quantities. | 31 | tends to use ``unsigned long`` for 64-bit quantities. |
30 | 32 | ||
31 | 5: Check your patch for general style as detailed in | 33 | 5) Check your patch for general style as detailed in |
32 | Documentation/CodingStyle. | 34 | :ref:`Documentation/CodingStyle <codingstyle>`. |
33 | Check for trivial violations with the patch style checker prior to | 35 | Check for trivial violations with the patch style checker prior to |
34 | submission (``scripts/checkpatch.pl``). | 36 | submission (``scripts/checkpatch.pl``). |
35 | You should be able to justify all violations that remain in | 37 | You should be able to justify all violations that remain in |
@@ -54,7 +56,7 @@ and elsewhere regarding submitting Linux kernel patches. | |||
54 | but any one function that uses more than 512 bytes on the stack is a | 56 | but any one function that uses more than 512 bytes on the stack is a |
55 | candidate for change. | 57 | candidate for change. |
56 | 58 | ||
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. |
58 | (Not required for static functions, but OK there also.) Use | 60 | (Not required for static functions, but OK there also.) Use |
59 | ``make htmldocs`` or ``make pdfdocs`` to check the | 61 | ``make htmldocs`` or ``make pdfdocs`` to check the |
60 | :ref:`kernel-doc <kernel_doc>` and fix any issues. | 62 | :ref:`kernel-doc <kernel_doc>` and fix any issues. |
diff --git a/Documentation/SubmittingDrivers b/Documentation/SubmittingDrivers index 2ac931645e53..252b77a23fad 100644 --- a/Documentation/SubmittingDrivers +++ b/Documentation/SubmittingDrivers | |||
@@ -40,9 +40,9 @@ Linux 2.4: | |||
40 | maintainer does not respond or you cannot find the appropriate | 40 | maintainer does not respond or you cannot find the appropriate |
41 | maintainer then please contact Willy Tarreau <w@1wt.eu>. | 41 | maintainer then please contact Willy Tarreau <w@1wt.eu>. |
42 | 42 | ||
43 | Linux 2.6: | 43 | Linux 2.6 and upper: |
44 | The same rules apply as 2.4 except that you should follow linux-kernel | 44 | 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+ |
46 | submissions is Andrew Morton. | 46 | submissions is Andrew Morton. |
47 | 47 | ||
48 | What Criteria Determine Acceptance | 48 | What Criteria Determine Acceptance |
@@ -73,7 +73,8 @@ Interfaces: | |||
73 | 73 | ||
74 | Code: | 74 | Code: |
75 | Please use the Linux style of code formatting as documented | 75 | 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 | ||
77 | that need to be in other formats, for example because they | 78 | that need to be in other formats, for example because they |
78 | are shared with a windows driver kit and you want to | 79 | are shared with a windows driver kit and you want to |
79 | maintain them just once separate them out nicely and note | 80 | maintain them just once separate them out nicely and note |
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 9c3dfa7babf3..36f1dedc944c 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches | |||
@@ -10,10 +10,12 @@ can greatly increase the chances of your change being accepted. | |||
10 | 10 | ||
11 | This document contains a large number of suggestions in a relatively terse | 11 | This document contains a large number of suggestions in a relatively terse |
12 | format. For detailed information on how the kernel development process | 12 | format. For detailed information on how the kernel development process |
13 | works, see Documentation/development-process. Also, read | 13 | works, see :ref:`Documentation/development-process <development_process_main>`. |
14 | Documentation/SubmitChecklist for a list of items to check before | 14 | Also, read :ref:`Documentation/SubmitChecklist <submitchecklist>` |
15 | for a list of items to check before | ||
15 | submitting code. If you are submitting a driver, also read | 16 | 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 | ||
17 | Documentation/devicetree/bindings/submitting-patches.txt. | 19 | Documentation/devicetree/bindings/submitting-patches.txt. |
18 | 20 | ||
19 | Many of these steps describe the default behavior of the ``git`` version | 21 | 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. | |||
235 | --------------------------- | 237 | --------------------------- |
236 | 238 | ||
237 | Check your patch for basic style violations, details of which can be | 239 | 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 | ||
239 | the reviewers time and will get your patch rejected, probably | 243 | the reviewers time and will get your patch rejected, probably |
240 | without even being read. | 244 | without even being read. |
241 | 245 | ||
@@ -300,8 +304,9 @@ toward the stable maintainers by putting a line like this:: | |||
300 | Cc: stable@vger.kernel.org | 304 | Cc: stable@vger.kernel.org |
301 | 305 | ||
302 | into the sign-off area of your patch (note, NOT an email recipient). You | 306 | 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 | 307 | should also read |
304 | file. | 308 | :ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>` |
309 | in addition to this file. | ||
305 | 310 | ||
306 | Note, however, that some subsystem maintainers want to come to their own | 311 | Note, however, that some subsystem maintainers want to come to their own |
307 | conclusions on which patches should go to the stable trees. The networking | 312 | 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. | |||
358 | Exception: If your mailer is mangling patches then someone may ask | 363 | Exception: If your mailer is mangling patches then someone may ask |
359 | you to re-send them using MIME. | 364 | you to re-send them using MIME. |
360 | 365 | ||
361 | See Documentation/email-clients.txt for hints about configuring | 366 | See :ref:`Documentation/email-clients.txt <email_clients>` |
362 | your e-mail client so that it sends your patches untouched. | 367 | for hints about configuring your e-mail client so that it sends your patches |
368 | untouched. | ||
363 | 369 | ||
364 | 7) E-mail size | 370 | 7) E-mail size |
365 | -------------- | 371 | -------------- |
@@ -823,7 +829,7 @@ NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! | |||
823 | <https://lkml.org/lkml/2005/7/11/336> | 829 | <https://lkml.org/lkml/2005/7/11/336> |
824 | 830 | ||
825 | Kernel Documentation/CodingStyle: | 831 | Kernel Documentation/CodingStyle: |
826 | <Documentation/CodingStyle> | 832 | :ref:`Documentation/CodingStyle <codingstyle>` |
827 | 833 | ||
828 | Linus Torvalds's mail on the canonical patch format: | 834 | Linus Torvalds's mail on the canonical patch format: |
829 | <http://lkml.org/lkml/2005/4/7/183> | 835 | <http://lkml.org/lkml/2005/4/7/183> |
diff --git a/Documentation/development-process/development-process.rst b/Documentation/development-process/development-process.rst index d431a1098875..bd1399f7202a 100644 --- a/Documentation/development-process/development-process.rst +++ b/Documentation/development-process/development-process.rst | |||
@@ -1,3 +1,5 @@ | |||
1 | .. _development_process_main: | ||
2 | |||
1 | A guide to the Kernel Development Process | 3 | A guide to the Kernel Development Process |
2 | ========================================= | 4 | ========================================= |
3 | 5 | ||
diff --git a/Documentation/stable_kernel_rules.txt b/Documentation/stable_kernel_rules.txt index 1eba72708c7f..4d82e31b7958 100644 --- a/Documentation/stable_kernel_rules.txt +++ b/Documentation/stable_kernel_rules.txt | |||
@@ -26,7 +26,9 @@ Rules on what kind of patches are accepted, and which ones are not, into the | |||
26 | race can be exploited is also provided. | 26 | race can be exploited is also provided. |
27 | - It cannot contain any "trivial" fixes in it (spelling changes, | 27 | - It cannot contain any "trivial" fixes in it (spelling changes, |
28 | whitespace cleanups, etc). | 28 | whitespace cleanups, etc). |
29 | - It must follow the Documentation/SubmittingPatches rules. | 29 | - It must follow the |
30 | :ref:`Documentation/SubmittingPatches <submittingpatches>` | ||
31 | rules. | ||
30 | - It or an equivalent fix must already exist in Linus' tree (upstream). | 32 | - It or an equivalent fix must already exist in Linus' tree (upstream). |
31 | 33 | ||
32 | 34 | ||
@@ -37,7 +39,8 @@ Procedure for submitting patches to the -stable tree | |||
37 | submission guidelines as described in | 39 | submission guidelines as described in |
38 | Documentation/networking/netdev-FAQ.txt | 40 | Documentation/networking/netdev-FAQ.txt |
39 | - Security patches should not be handled (solely) by the -stable review | 41 | - 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>`. | ||
41 | 44 | ||
42 | For all other submissions, choose one of the following procedures | 45 | For all other submissions, choose one of the following procedures |
43 | ----------------------------------------------------------------- | 46 | ----------------------------------------------------------------- |