Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
dca22a63 06ad6367

+32 -18
+6 -4
Documentation/SubmitChecklist
··· 1 + .. _submitchecklist: 2 + 1 3 Linux Kernel patch submission checklist 2 4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3 5 ··· 7 5 kernel patch submissions accepted more quickly. 8 6 9 7 These are all above and beyond the documentation that is provided in 10 - Documentation/SubmittingPatches 8 + :ref:`Documentation/SubmittingPatches <submittingpatches>` 11 9 and elsewhere regarding submitting Linux kernel patches. 12 10 13 11 ··· 30 28 4) ppc64 is a good architecture for cross-compilation checking because it 31 29 tends to use ``unsigned long`` for 64-bit quantities. 32 30 33 - 5: Check your patch for general style as detailed in 34 - Documentation/CodingStyle. 31 + 5) Check your patch for general style as detailed in 32 + :ref:`Documentation/CodingStyle <codingstyle>`. 35 33 Check for trivial violations with the patch style checker prior to 36 34 submission (``scripts/checkpatch.pl``). 37 35 You should be able to justify all violations that remain in ··· 56 54 but any one function that uses more than 512 bytes on the stack is a 57 55 candidate for change. 58 56 59 - 11: Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs. 57 + 11) Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs. 60 58 (Not required for static functions, but OK there also.) Use 61 59 ``make htmldocs`` or ``make pdfdocs`` to check the 62 60 :ref:`kernel-doc <kernel_doc>` and fix any issues.
+4 -3
Documentation/SubmittingDrivers
··· 40 40 maintainer does not respond or you cannot find the appropriate 41 41 maintainer then please contact Willy Tarreau <w@1wt.eu>. 42 42 43 - Linux 2.6: 43 + Linux 2.6 and upper: 44 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 46 submissions is Andrew Morton. 47 47 48 48 What Criteria Determine Acceptance ··· 73 73 74 74 Code: 75 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 78 that need to be in other formats, for example because they 78 79 are shared with a windows driver kit and you want to 79 80 maintain them just once separate them out nicely and note
+15 -9
Documentation/SubmittingPatches
··· 10 10 11 11 This document contains a large number of suggestions in a relatively terse 12 12 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 15 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 19 Documentation/devicetree/bindings/submitting-patches.txt. 18 20 19 21 Many of these steps describe the default behavior of the ``git`` version ··· 237 235 --------------------------- 238 236 239 237 Check your patch for basic style violations, details of which can be 240 - found in Documentation/CodingStyle. Failure to do so simply wastes 238 + found in 239 + :ref:`Documentation/CodingStyle <codingstyle>`. 240 + Failure to do so simply wastes 241 241 the reviewers time and will get your patch rejected, probably 242 242 without even being read. 243 243 ··· 304 300 Cc: stable@vger.kernel.org 305 301 306 302 into the sign-off area of your patch (note, NOT an email recipient). You 307 - should also read Documentation/stable_kernel_rules.txt in addition to this 308 - file. 303 + should also read 304 + :ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>` 305 + in addition to this file. 309 306 310 307 Note, however, that some subsystem maintainers want to come to their own 311 308 conclusions on which patches should go to the stable trees. The networking ··· 363 358 Exception: If your mailer is mangling patches then someone may ask 364 359 you to re-send them using MIME. 365 360 366 - See Documentation/email-clients.txt for hints about configuring 367 - your e-mail client so that it sends your patches untouched. 361 + See :ref:`Documentation/email-clients.txt <email_clients>` 362 + for hints about configuring your e-mail client so that it sends your patches 363 + untouched. 368 364 369 365 7) E-mail size 370 366 -------------- ··· 829 823 <https://lkml.org/lkml/2005/7/11/336> 830 824 831 825 Kernel Documentation/CodingStyle: 832 - <Documentation/CodingStyle> 826 + :ref:`Documentation/CodingStyle <codingstyle>` 833 827 834 828 Linus Torvalds's mail on the canonical patch format: 835 829 <http://lkml.org/lkml/2005/4/7/183>
+2
Documentation/development-process/development-process.rst
··· 1 + .. _development_process_main: 2 + 1 3 A guide to the Kernel Development Process 2 4 ========================================= 3 5
+5 -2
Documentation/stable_kernel_rules.txt
··· 26 26 race can be exploited is also provided. 27 27 - It cannot contain any "trivial" fixes in it (spelling changes, 28 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 32 - It or an equivalent fix must already exist in Linus' tree (upstream). 31 33 32 34 ··· 39 37 submission guidelines as described in 40 38 Documentation/networking/netdev-FAQ.txt 41 39 - Security patches should not be handled (solely) by the -stable review 42 - process but should follow the procedures in Documentation/SecurityBugs. 40 + process but should follow the procedures in 41 + :ref:`Documentation/SecurityBugs <securitybugs>`. 43 42 44 43 For all other submissions, choose one of the following procedures 45 44 -----------------------------------------------------------------