Gitiles
Code Review Sign In
review.evervolv.com / android_kernel_htc_msm8960 / ae40eb1ef30ab4120bd3c8b7e3da99ee53d27a23 / . / Documentation / SubmitChecklist
blob: bd23dc0bc0c7c9ced4323b761396377d700fad83 [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()
Randy Dunlap1a036cd2006-09-29 02:01:26 -0700[diff] [blame]64
6519: All new userspace interfaces are documented in Documentation/ABI/.
66 See Documentation/ABI/README for more information.
Andrew Mortonce584f92006-09-30 23:27:39 -0700[diff] [blame]67
6820: Check that it all passes `make headers_check'.
Andrew Morton0dd4e5b2006-12-10 02:18:56 -0800[diff] [blame]69
7021: Has been checked with injection of at least slab and page-allocation
71 fauilures. See Documentation/fault-injection/.
72
73 If the new code is substantial, addition of subsystem-specific fault
74 injection might be appropriate.
Andrew Mortona517b9f2007-01-22 20:40:36 -0800[diff] [blame]75
7622: Newly-added code has been compiled with `gcc -W'. This will generate
77 lots of noise, but is good for finding bugs like "warning: comparison
78 between signed and unsigned".
Randy Dunlap244474b2007-02-28 20:12:35 -0800[diff] [blame]79
8023: Tested after it has been merged into the -mm patchset to make sure
81 that it still works with all of the other queued patches and various
82 changes in the VM, VFS, and other subsystems.