Blame view
Documentation/SubmitChecklist
4.36 KB
8b7ecb113 SubmitChecklist u... |
1 |
Linux Kernel patch submission checklist |
915a56d23 [PATCH] add Doc/S... |
2 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
e54695a59 [PATCH] checklist... |
3 4 |
Here are some basic things that developers should do if they want to see their kernel patch submissions accepted more quickly. |
915a56d23 [PATCH] add Doc/S... |
5 |
|
e54695a59 [PATCH] checklist... |
6 7 8 |
These are all above and beyond the documentation that is provided in Documentation/SubmittingPatches and elsewhere regarding submitting Linux kernel patches. |
915a56d23 [PATCH] add Doc/S... |
9 |
|
b5247c854 Documentation/Sub... |
10 11 12 13 14 |
1: If you use a facility then #include the file that defines/declares that facility. Don't depend on other header files pulling in ones that you use. 2: Builds cleanly with applicable or modified CONFIG options =y, =m, and |
e54695a59 [PATCH] checklist... |
15 |
=n. No gcc warnings/errors, no linker warnings/errors. |
915a56d23 [PATCH] add Doc/S... |
16 |
|
b5247c854 Documentation/Sub... |
17 |
2b: Passes allnoconfig, allmodconfig |
915a56d23 [PATCH] add Doc/S... |
18 |
|
85f9642e3 Documentation: up... |
19 |
2c: Builds successfully when using O=builddir |
e54695a59 [PATCH] checklist... |
20 |
3: Builds on multiple CPU architectures by using local cross-compile tools |
7de3369c1 doc: SubmitCheckl... |
21 |
or some other build farm. |
915a56d23 [PATCH] add Doc/S... |
22 |
|
e54695a59 [PATCH] checklist... |
23 24 |
4: ppc64 is a good architecture for cross-compilation checking because it tends to use `unsigned long' for 64-bit quantities. |
915a56d23 [PATCH] add Doc/S... |
25 |
|
df24d9a6a Documentation: pr... |
26 27 28 29 30 |
5: Check your patch for general style as detailed in Documentation/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 your patch. |
915a56d23 [PATCH] add Doc/S... |
31 |
|
e54695a59 [PATCH] checklist... |
32 |
6: Any new or modified CONFIG options don't muck up the config menu. |
915a56d23 [PATCH] add Doc/S... |
33 |
|
e54695a59 [PATCH] checklist... |
34 |
7: All new Kconfig options have help text. |
915a56d23 [PATCH] add Doc/S... |
35 |
|
e54695a59 [PATCH] checklist... |
36 37 38 |
8: Has been carefully reviewed with respect to relevant Kconfig combinations. This is very hard to get right with testing -- brainpower pays off here. |
915a56d23 [PATCH] add Doc/S... |
39 |
|
e54695a59 [PATCH] checklist... |
40 |
9: Check cleanly with sparse. |
915a56d23 [PATCH] add Doc/S... |
41 |
|
e54695a59 [PATCH] checklist... |
42 43 44 45 |
10: Use 'make checkstack' and 'make namespacecheck' and fix any problems that they find. Note: checkstack does not point out problems explicitly, but any one function that uses more than 512 bytes on the stack is a candidate for change. |
915a56d23 [PATCH] add Doc/S... |
46 |
|
e54695a59 [PATCH] checklist... |
47 48 49 |
11: Include kernel-doc to document global kernel APIs. (Not required for static functions, but OK there also.) Use 'make htmldocs' or 'make mandocs' to check the kernel-doc and fix any issues. |
915a56d23 [PATCH] add Doc/S... |
50 |
|
e54695a59 [PATCH] checklist... |
51 52 |
12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, |
df2694d80 Documentation/Sub... |
53 54 |
CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_ATOMIC_SLEEP, CONFIG_PROVE_RCU and CONFIG_DEBUG_OBJECTS_RCU_HEAD all simultaneously enabled. |
915a56d23 [PATCH] add Doc/S... |
55 |
|
e54695a59 [PATCH] checklist... |
56 57 |
13: Has been build- and runtime tested with and without CONFIG_SMP and CONFIG_PREEMPT. |
915a56d23 [PATCH] add Doc/S... |
58 |
|
e54695a59 [PATCH] checklist... |
59 |
14: If the patch affects IO/Disk, etc: has been tested with and without |
90c699a9e block: rename CON... |
60 |
CONFIG_LBDAF. |
915a56d23 [PATCH] add Doc/S... |
61 |
|
e54695a59 [PATCH] checklist... |
62 |
15: All codepaths have been exercised with all lockdep features enabled. |
915a56d23 [PATCH] add Doc/S... |
63 |
|
e54695a59 [PATCH] checklist... |
64 65 66 67 68 69 |
16: All new /proc entries are documented under Documentation/ 17: All new kernel boot parameters are documented in Documentation/kernel-parameters.txt. 18: All new module parameters are documented with MODULE_PARM_DESC() |
1a036cdd9 [PATCH] Mention D... |
70 71 72 |
19: All new userspace interfaces are documented in Documentation/ABI/. See Documentation/ABI/README for more information. |
1d992ce90 SubmitChecklist: ... |
73 74 |
Patches that change userspace interfaces should be CCed to linux-api@vger.kernel.org. |
ce584f913 [PATCH] submit ch... |
75 76 |
20: Check that it all passes `make headers_check'. |
0dd4e5b8e [PATCH] submit ch... |
77 78 |
21: Has been checked with injection of at least slab and page-allocation |
80abe55b5 Documentation: Fi... |
79 |
failures. See Documentation/fault-injection/. |
0dd4e5b8e [PATCH] submit ch... |
80 81 82 |
If the new code is substantial, addition of subsystem-specific fault injection might be appropriate. |
a517b9f9f [PATCH] SubmitChe... |
83 |
|
980916966 SubmitChecklist: ... |
84 85 86 |
22: Newly-added code has been compiled with `gcc -W' (use "make EXTRA_CFLAGS=-W"). This will generate lots of noise, but is good for finding bugs like "warning: comparison between signed and unsigned". |
244474b21 [PATCH] add -mm t... |
87 88 89 90 |
23: Tested after it has been merged into the -mm patchset to make sure that it still works with all of the other queued patches and various changes in the VM, VFS, and other subsystems. |
8033fe65a documentation: ex... |
91 92 93 |
24: All memory barriers {e.g., barrier(), rmb(), wmb()} need a comment in the source code that explains the logic of what they are doing and why. |
7de3369c1 doc: SubmitCheckl... |
94 95 96 |
25: If any ioctl's are added by the patch, then also update Documentation/ioctl/ioctl-number.txt. |
85f9642e3 Documentation: up... |
97 98 99 100 101 102 103 104 |
26: If your modified source code depends on or uses any of the kernel APIs or features that are related to the following kconfig symbols, then test multiple builds with the related kconfig symbols disabled and/or =m (if that option is available) [not all of these at the same time, just various/random combinations of them]: CONFIG_SMP, CONFIG_SYSFS, CONFIG_PROC_FS, CONFIG_INPUT, CONFIG_PCI, |
40b313608 Finally eradicate... |
105 |
CONFIG_BLOCK, CONFIG_PM, CONFIG_MAGIC_SYSRQ, |
85f9642e3 Documentation: up... |
106 |
CONFIG_NET, CONFIG_INET=n (but latter with CONFIG_NET=y) |