Skip to content

Commit 47c67ec

Browse files
bulwahnJonathan Corbet
authored andcommitted
docs: submit-checklist: use subheadings
During review (see Link), Jani Nikula suggested to use proper subheadings instead of using italics to indicate the different new top-level categories in the checklist. Further the top heading should follow the common scheme. Use subheadings. Adjust to common heading adornment. Link: https://lore.kernel.org/linux-doc/[email protected]/ Signed-off-by: Lukas Bulwahn <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Message-ID: <[email protected]>
1 parent 5969fbf commit 47c67ec

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

Documentation/process/submit-checklist.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _submitchecklist:
22

3+
=======================================
34
Linux Kernel patch submission checklist
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5+
=======================================
56

67
Here are some basic things that developers should do if they want to see their
78
kernel patch submissions accepted more quickly.
@@ -10,8 +11,8 @@ These are all above and beyond the documentation that is provided in
1011
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
1112
and elsewhere regarding submitting Linux kernel patches.
1213

13-
14-
*Review your code:*
14+
Review your code
15+
================
1516

1617
1) If you use a facility then #include the file that defines/declares
1718
that facility. Don't depend on other header files pulling in ones
@@ -24,8 +25,8 @@ and elsewhere regarding submitting Linux kernel patches.
2425
comment in the source code that explains the logic of what they are doing
2526
and why.
2627

27-
28-
*Review Kconfig changes:*
28+
Review Kconfig changes
29+
======================
2930

3031
1) Any new or modified ``CONFIG`` options do not muck up the config menu and
3132
default to off unless they meet the exception criteria documented in
@@ -37,7 +38,8 @@ and elsewhere regarding submitting Linux kernel patches.
3738
combinations. This is very hard to get right with testing---brainpower
3839
pays off here.
3940

40-
*Provide documentation:*
41+
Provide documentation
42+
=====================
4143

4244
1) Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
4345
(Not required for static functions, but OK there also.)
@@ -57,8 +59,8 @@ and elsewhere regarding submitting Linux kernel patches.
5759
6) If any ioctl's are added by the patch, then also update
5860
``Documentation/userspace-api/ioctl/ioctl-number.rst``.
5961

60-
61-
*Check your code with tools:*
62+
Check your code with tools
63+
==========================
6264

6365
1) Check for trivial violations with the patch style checker prior to
6466
submission (``scripts/checkpatch.pl``).
@@ -72,8 +74,8 @@ and elsewhere regarding submitting Linux kernel patches.
7274
but any one function that uses more than 512 bytes on the stack is a
7375
candidate for change.
7476

75-
76-
*Build your code:*
77+
Build your code
78+
===============
7779

7880
1) Builds cleanly:
7981

@@ -107,8 +109,8 @@ and elsewhere regarding submitting Linux kernel patches.
107109
``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,
108110
``CONFIG_NET``, ``CONFIG_INET=n`` (but latter with ``CONFIG_NET=y``).
109111

110-
111-
*Test your code:*
112+
Test your code
113+
==============
112114

113115
1) Has been tested with ``CONFIG_PREEMPT``, ``CONFIG_DEBUG_PREEMPT``,
114116
``CONFIG_SLUB_DEBUG``, ``CONFIG_DEBUG_PAGEALLOC``, ``CONFIG_DEBUG_MUTEXES``,

0 commit comments

Comments
 (0)