diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-21 08:51:05 -0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-09-21 15:43:09 -0600 |
| commit | dca22a63fd036c3ebb50212060eba0080f178126 (patch) | |
| tree | 5b916da6aca03344aab37c9e1922ed22e3471287 /Documentation/SubmitChecklist | |
| parent | 06ad6367101c0ba65c863287468539e3d8c69ca3 (diff) | |
| download | blackbird-op-linux-dca22a63fd036c3ebb50212060eba0080f178126.tar.gz blackbird-op-linux-dca22a63fd036c3ebb50212060eba0080f178126.zip | |
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>
Diffstat (limited to 'Documentation/SubmitChecklist')
| -rw-r--r-- | Documentation/SubmitChecklist | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist index 22a370ff34e5..894289b22b15 100644 --- a/Documentation/SubmitChecklist +++ b/Documentation/SubmitChecklist @@ -1,3 +1,5 @@ +.. _submitchecklist: + Linux Kernel patch submission checklist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -5,7 +7,7 @@ Here are some basic things that developers should do if they want to see their kernel patch submissions accepted more quickly. These are all above and beyond the documentation that is provided in -Documentation/SubmittingPatches +:ref:`Documentation/SubmittingPatches <submittingpatches>` and elsewhere regarding submitting Linux kernel patches. @@ -28,8 +30,8 @@ and elsewhere regarding submitting Linux kernel patches. 4) ppc64 is a good architecture for cross-compilation checking because it tends to use ``unsigned long`` for 64-bit quantities. -5: Check your patch for general style as detailed in - Documentation/CodingStyle. +5) Check your patch for general style as detailed in + :ref:`Documentation/CodingStyle <codingstyle>`. Check for trivial violations with the patch style checker prior to submission (``scripts/checkpatch.pl``). You should be able to justify all violations that remain in @@ -54,7 +56,7 @@ and elsewhere regarding submitting Linux kernel patches. but any one function that uses more than 512 bytes on the stack is a candidate for change. -11: Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs. +11) Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs. (Not required for static functions, but OK there also.) Use ``make htmldocs`` or ``make pdfdocs`` to check the :ref:`kernel-doc <kernel_doc>` and fix any issues. |
