Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / e54695a59c278b9ff48cd4b263da7a1d392f5061 / . / Documentation / SubmitChecklist
blob: a10bfb6ecd9fa4e55c9beecd2e588c9a0359ec71 [file] [log] [blame]
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]1Linux Kernel patch sumbittal checklist
2~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]4Here are some basic things that developers should do if they want to see their
5kernel patch submissions accepted more quickly.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]6
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]7These are all above and beyond the documentation that is provided in
8Documentation/SubmittingPatches and elsewhere regarding submitting Linux
9kernel patches.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]10
11
12
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]131: Builds cleanly with applicable or modified CONFIG options =y, =m, and
14 =n. No gcc warnings/errors, no linker warnings/errors.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]15
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]162: Passes allnoconfig, allmodconfig
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]17
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]183: Builds on multiple CPU architectures by using local cross-compile tools
19 or something like PLM at OSDL.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]20
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]214: ppc64 is a good architecture for cross-compilation checking because it
22 tends to use `unsigned long' for 64-bit quantities.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]23
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]245: Matches kernel coding style(!)
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]25
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]266: Any new or modified CONFIG options don't muck up the config menu.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]27
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]287: All new Kconfig options have help text.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]29
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]308: Has been carefully reviewed with respect to relevant Kconfig
31 combinations. This is very hard to get right with testing -- brainpower
32 pays off here.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]33
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]349: Check cleanly with sparse.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]35
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]3610: Use 'make checkstack' and 'make namespacecheck' and fix any problems
37 that they find. Note: checkstack does not point out problems explicitly,
38 but any one function that uses more than 512 bytes on the stack is a
39 candidate for change.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]40
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]4111: Include kernel-doc to document global kernel APIs. (Not required for
42 static functions, but OK there also.) Use 'make htmldocs' or 'make
43 mandocs' to check the kernel-doc and fix any issues.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]44
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]4512: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT,
46 CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,
47 CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_SPINLOCK_SLEEP all simultaneously
48 enabled.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]49
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]5013: Has been build- and runtime tested with and without CONFIG_SMP and
51 CONFIG_PREEMPT.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]52
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]5314: If the patch affects IO/Disk, etc: has been tested with and without
54 CONFIG_LBD.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]55
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]5615: All codepaths have been exercised with all lockdep features enabled.
Randy Dunlap915a56d2006-06-23 02:05:49 -0700[diff] [blame]57
Andrew Mortone54695a2006-07-10 04:45:42 -0700[diff] [blame^]5816: All new /proc entries are documented under Documentation/
59
6017: All new kernel boot parameters are documented in
61 Documentation/kernel-parameters.txt.
62
6318: All new module parameters are documented with MODULE_PARM_DESC()