diff options
Diffstat (limited to 'Documentation/SubmitChecklist')
-rw-r--r-- | Documentation/SubmitChecklist | 76 |
1 files changed, 41 insertions, 35 deletions
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist index 8230098da529..a10bfb6ecd9f 100644 --- a/Documentation/SubmitChecklist +++ b/Documentation/SubmitChecklist | |||
@@ -1,57 +1,63 @@ | |||
1 | Linux Kernel patch sumbittal checklist | 1 | Linux Kernel patch sumbittal checklist |
2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
3 | 3 | ||
4 | Here are some basic things that developers should do if they | 4 | Here are some basic things that developers should do if they want to see their |
5 | want to see their kernel patch submittals accepted quicker. | 5 | kernel patch submissions accepted more quickly. |
6 | 6 | ||
7 | These are all above and beyond the documentation that is provided | 7 | These are all above and beyond the documentation that is provided in |
8 | in Documentation/SubmittingPatches and elsewhere about submitting | 8 | Documentation/SubmittingPatches and elsewhere regarding submitting Linux |
9 | Linux kernel patches. | 9 | kernel patches. |
10 | 10 | ||
11 | 11 | ||
12 | 12 | ||
13 | - Builds cleanly with applicable or modified CONFIG options =y, =m, and =n. | 13 | 1: Builds cleanly with applicable or modified CONFIG options =y, =m, and |
14 | No gcc warnings/errors, no linker warnings/errors. | 14 | =n. No gcc warnings/errors, no linker warnings/errors. |
15 | 15 | ||
16 | - Passes allnoconfig, allmodconfig | 16 | 2: Passes allnoconfig, allmodconfig |
17 | 17 | ||
18 | - Builds on multiple CPU arch-es by using local cross-compile tools | 18 | 3: Builds on multiple CPU architectures by using local cross-compile tools |
19 | or something like PLM at OSDL. | 19 | or something like PLM at OSDL. |
20 | 20 | ||
21 | - ppc64 is a good architecture for cross-compilation checking because it | 21 | 4: ppc64 is a good architecture for cross-compilation checking because it |
22 | tends to use `unsigned long' for 64-bit quantities. | 22 | tends to use `unsigned long' for 64-bit quantities. |
23 | 23 | ||
24 | - Matches kernel coding style(!) | 24 | 5: Matches kernel coding style(!) |
25 | 25 | ||
26 | - Any new or modified CONFIG options don't muck up the config menu. | 26 | 6: Any new or modified CONFIG options don't muck up the config menu. |
27 | 27 | ||
28 | - All new Kconfig options have help text. | 28 | 7: All new Kconfig options have help text. |
29 | 29 | ||
30 | - Has been carefully reviewed with respect to relevant Kconfig | 30 | 8: Has been carefully reviewed with respect to relevant Kconfig |
31 | combinations. This is very hard to get right with testing -- | 31 | combinations. This is very hard to get right with testing -- brainpower |
32 | brainpower pays off here. | 32 | pays off here. |
33 | 33 | ||
34 | - Check cleanly with sparse. | 34 | 9: Check cleanly with sparse. |
35 | 35 | ||
36 | - Use 'make checkstack' and 'make namespacecheck' and fix any | 36 | 10: Use 'make checkstack' and 'make namespacecheck' and fix any problems |
37 | problems that they find. Note: checkstack does not point out | 37 | that they find. Note: checkstack does not point out problems explicitly, |
38 | problems explicitly, but any one function that uses more than | 38 | but any one function that uses more than 512 bytes on the stack is a |
39 | 512 bytes on the stack is a candidate for change. | 39 | candidate for change. |
40 | 40 | ||
41 | - Include kernel-doc to document global kernel APIs. (Not required | 41 | 11: Include kernel-doc to document global kernel APIs. (Not required for |
42 | for static functions, but OK there also.) Use 'make htmldocs' | 42 | static functions, but OK there also.) Use 'make htmldocs' or 'make |
43 | or 'make mandocs' to check the kernel-doc and fix any issues. | 43 | mandocs' to check the kernel-doc and fix any issues. |
44 | 44 | ||
45 | - Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, | 45 | 12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, |
46 | CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, | 46 | CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, |
47 | CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_SPINLOCK_SLEEP all simultaneously | 47 | CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_SPINLOCK_SLEEP all simultaneously |
48 | enabled. | 48 | enabled. |
49 | 49 | ||
50 | - Has been build- and runtime tested with and without CONFIG_SMP and | 50 | 13: Has been build- and runtime tested with and without CONFIG_SMP and |
51 | CONFIG_PREEMPT. | 51 | CONFIG_PREEMPT. |
52 | 52 | ||
53 | - If the patch affects IO/Disk, etc: has been tested with and without | 53 | 14: If the patch affects IO/Disk, etc: has been tested with and without |
54 | CONFIG_LBD. | 54 | CONFIG_LBD. |
55 | 55 | ||
56 | 15: All codepaths have been exercised with all lockdep features enabled. | ||
56 | 57 | ||
57 | 2006-APR-27 | 58 | 16: All new /proc entries are documented under Documentation/ |
59 | |||
60 | 17: All new kernel boot parameters are documented in | ||
61 | Documentation/kernel-parameters.txt. | ||
62 | |||
63 | 18: All new module parameters are documented with MODULE_PARM_DESC() | ||