Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 7de3369c14b67fe77d8b5f65171bb3a3b4f371ba

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 1d81a181e0
Exists in master and in 7 other branches imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-l5.0.0_1.0.0-ga

doc: SubmitChecklist, add ioctls, remove OSDL reference 

If a patch adds ioctls, then Documentation/ioctl/ioctl-number.txt
should also be updated.

Remove reference to the OSDL PLM build farm.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 4 additions and 1 deletions Inline Diff

Documentation/SubmitChecklist
Diff comments   View file @ 7de3369
1 Linux Kernel patch submission checklist 1 Linux Kernel patch submission checklist
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3 3
4 Here are some basic things that developers should do if they want to see their 4 Here are some basic things that developers should do if they want to see their
5 kernel patch submissions accepted more quickly. 5 kernel patch submissions accepted more quickly.
6 6
7 These are all above and beyond the documentation that is provided in 7 These are all above and beyond the documentation that is provided in
8 Documentation/SubmittingPatches and elsewhere regarding submitting Linux 8 Documentation/SubmittingPatches and elsewhere regarding submitting Linux
9 kernel patches. 9 kernel patches.
10 10
11 11
12 1: Builds cleanly with applicable or modified CONFIG options =y, =m, and 12 1: Builds cleanly with applicable or modified CONFIG options =y, =m, and
13 =n. No gcc warnings/errors, no linker warnings/errors. 13 =n. No gcc warnings/errors, no linker warnings/errors.
14 14
15 2: Passes allnoconfig, allmodconfig 15 2: Passes allnoconfig, allmodconfig
16 16
17 3: Builds on multiple CPU architectures by using local cross-compile tools 17 3: Builds on multiple CPU architectures by using local cross-compile tools
18 or something like PLM at OSDL. 18 or some other build farm.
19 19
20 4: ppc64 is a good architecture for cross-compilation checking because it 20 4: ppc64 is a good architecture for cross-compilation checking because it
21 tends to use `unsigned long' for 64-bit quantities. 21 tends to use `unsigned long' for 64-bit quantities.
22 22
23 5: Check your patch for general style as detailed in 23 5: Check your patch for general style as detailed in
24 Documentation/CodingStyle. Check for trivial violations with the 24 Documentation/CodingStyle. Check for trivial violations with the
25 patch style checker prior to submission (scripts/checkpatch.pl). 25 patch style checker prior to submission (scripts/checkpatch.pl).
26 You should be able to justify all violations that remain in 26 You should be able to justify all violations that remain in
27 your patch. 27 your patch.
28 28
29 6: Any new or modified CONFIG options don't muck up the config menu. 29 6: Any new or modified CONFIG options don't muck up the config menu.
30 30
31 7: All new Kconfig options have help text. 31 7: All new Kconfig options have help text.
32 32
33 8: Has been carefully reviewed with respect to relevant Kconfig 33 8: Has been carefully reviewed with respect to relevant Kconfig
34 combinations. This is very hard to get right with testing -- brainpower 34 combinations. This is very hard to get right with testing -- brainpower
35 pays off here. 35 pays off here.
36 36
37 9: Check cleanly with sparse. 37 9: Check cleanly with sparse.
38 38
39 10: Use 'make checkstack' and 'make namespacecheck' and fix any problems 39 10: Use 'make checkstack' and 'make namespacecheck' and fix any problems
40 that they find. Note: checkstack does not point out problems explicitly, 40 that they find. Note: checkstack does not point out problems explicitly,
41 but any one function that uses more than 512 bytes on the stack is a 41 but any one function that uses more than 512 bytes on the stack is a
42 candidate for change. 42 candidate for change.
43 43
44 11: Include kernel-doc to document global kernel APIs. (Not required for 44 11: Include kernel-doc to document global kernel APIs. (Not required for
45 static functions, but OK there also.) Use 'make htmldocs' or 'make 45 static functions, but OK there also.) Use 'make htmldocs' or 'make
46 mandocs' to check the kernel-doc and fix any issues. 46 mandocs' to check the kernel-doc and fix any issues.
47 47
48 12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, 48 12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT,
49 CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, 49 CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,
50 CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_SPINLOCK_SLEEP all simultaneously 50 CONFIG_DEBUG_SPINLOCK, CONFIG_DEBUG_SPINLOCK_SLEEP all simultaneously
51 enabled. 51 enabled.
52 52
53 13: Has been build- and runtime tested with and without CONFIG_SMP and 53 13: Has been build- and runtime tested with and without CONFIG_SMP and
54 CONFIG_PREEMPT. 54 CONFIG_PREEMPT.
55 55
56 14: If the patch affects IO/Disk, etc: has been tested with and without 56 14: If the patch affects IO/Disk, etc: has been tested with and without
57 CONFIG_LBDAF. 57 CONFIG_LBDAF.
58 58
59 15: All codepaths have been exercised with all lockdep features enabled. 59 15: All codepaths have been exercised with all lockdep features enabled.
60 60
61 16: All new /proc entries are documented under Documentation/ 61 16: All new /proc entries are documented under Documentation/
62 62
63 17: All new kernel boot parameters are documented in 63 17: All new kernel boot parameters are documented in
64 Documentation/kernel-parameters.txt. 64 Documentation/kernel-parameters.txt.
65 65
66 18: All new module parameters are documented with MODULE_PARM_DESC() 66 18: All new module parameters are documented with MODULE_PARM_DESC()
67 67
68 19: All new userspace interfaces are documented in Documentation/ABI/. 68 19: All new userspace interfaces are documented in Documentation/ABI/.
69 See Documentation/ABI/README for more information. 69 See Documentation/ABI/README for more information.
70 Patches that change userspace interfaces should be CCed to 70 Patches that change userspace interfaces should be CCed to
71 linux-api@vger.kernel.org. 71 linux-api@vger.kernel.org.
72 72
73 20: Check that it all passes `make headers_check'. 73 20: Check that it all passes `make headers_check'.
74 74
75 21: Has been checked with injection of at least slab and page-allocation 75 21: Has been checked with injection of at least slab and page-allocation
76 failures. See Documentation/fault-injection/. 76 failures. See Documentation/fault-injection/.
77 77
78 If the new code is substantial, addition of subsystem-specific fault 78 If the new code is substantial, addition of subsystem-specific fault
79 injection might be appropriate. 79 injection might be appropriate.
80 80
81 22: Newly-added code has been compiled with `gcc -W' (use "make 81 22: Newly-added code has been compiled with `gcc -W' (use "make
82 EXTRA_CFLAGS=-W"). This will generate lots of noise, but is good for 82 EXTRA_CFLAGS=-W"). This will generate lots of noise, but is good for
83 finding bugs like "warning: comparison between signed and unsigned". 83 finding bugs like "warning: comparison between signed and unsigned".
84 84
85 23: Tested after it has been merged into the -mm patchset to make sure 85 23: Tested after it has been merged into the -mm patchset to make sure
86 that it still works with all of the other queued patches and various 86 that it still works with all of the other queued patches and various
87 changes in the VM, VFS, and other subsystems. 87 changes in the VM, VFS, and other subsystems.
88 88
89 24: All memory barriers {e.g., barrier(), rmb(), wmb()} need a comment in the 89 24: All memory barriers {e.g., barrier(), rmb(), wmb()} need a comment in the
90 source code that explains the logic of what they are doing and why. 90 source code that explains the logic of what they are doing and why.
91
92 25: If any ioctl's are added by the patch, then also update
93 Documentation/ioctl/ioctl-number.txt.
91 94