hc
2024-10-12 a5969cabbb4660eab42b6ef0412cbbd1200cf14d
kernel/Documentation/process/submit-checklist.rst
....@@ -24,6 +24,10 @@
2424
2525 c) Builds successfully when using ``O=builddir``
2626
27
+ d) Any Documentation/ changes build successfully without new warnings/errors.
28
+ Use ``make htmldocs`` or ``make pdfdocs`` to check the build and
29
+ fix any issues.
30
+
2731 3) Builds on multiple CPU architectures by using local cross-compile tools
2832 or some other build farm.
2933
....@@ -39,7 +43,7 @@
3943
4044 6) Any new or modified ``CONFIG`` options do not muck up the config menu and
4145 default to off unless they meet the exception criteria documented in
42
- ``Documentation/kbuild/kconfig-language.txt`` Menu attributes: default value.
46
+ ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.
4347
4448 7) All new ``Kconfig`` options have help text.
4549
....@@ -49,8 +53,7 @@
4953
5054 9) Check cleanly with sparse.
5155
52
-10) Use ``make checkstack`` and ``make namespacecheck`` and fix any problems
53
- that they find.
56
+10) Use ``make checkstack`` and fix any problems that it finds.
5457
5558 .. note::
5659
....@@ -72,47 +75,44 @@
7275 13) Has been build- and runtime tested with and without ``CONFIG_SMP`` and
7376 ``CONFIG_PREEMPT.``
7477
75
-14) If the patch affects IO/Disk, etc: has been tested with and without
76
- ``CONFIG_LBDAF.``
78
+16) All codepaths have been exercised with all lockdep features enabled.
7779
78
-15) All codepaths have been exercised with all lockdep features enabled.
80
+17) All new ``/proc`` entries are documented under ``Documentation/``
7981
80
-16) All new ``/proc`` entries are documented under ``Documentation/``
81
-
82
-17) All new kernel boot parameters are documented in
82
+18) All new kernel boot parameters are documented in
8383 ``Documentation/admin-guide/kernel-parameters.rst``.
8484
85
-18) All new module parameters are documented with ``MODULE_PARM_DESC()``
85
+19) All new module parameters are documented with ``MODULE_PARM_DESC()``
8686
87
-19) All new userspace interfaces are documented in ``Documentation/ABI/``.
87
+20) All new userspace interfaces are documented in ``Documentation/ABI/``.
8888 See ``Documentation/ABI/README`` for more information.
8989 Patches that change userspace interfaces should be CCed to
9090 linux-api@vger.kernel.org.
9191
92
-20) Check that it all passes ``make headers_check``.
92
+21) Check that it all passes ``make headers_check``.
9393
94
-21) Has been checked with injection of at least slab and page-allocation
94
+22) Has been checked with injection of at least slab and page-allocation
9595 failures. See ``Documentation/fault-injection/``.
9696
9797 If the new code is substantial, addition of subsystem-specific fault
9898 injection might be appropriate.
9999
100
-22) Newly-added code has been compiled with ``gcc -W`` (use
100
+23) Newly-added code has been compiled with ``gcc -W`` (use
101101 ``make EXTRA_CFLAGS=-W``). This will generate lots of noise, but is good
102102 for finding bugs like "warning: comparison between signed and unsigned".
103103
104
-23) Tested after it has been merged into the -mm patchset to make sure
104
+24) Tested after it has been merged into the -mm patchset to make sure
105105 that it still works with all of the other queued patches and various
106106 changes in the VM, VFS, and other subsystems.
107107
108
-24) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
108
+25) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
109109 comment in the source code that explains the logic of what they are doing
110110 and why.
111111
112
-25) If any ioctl's are added by the patch, then also update
113
- ``Documentation/ioctl/ioctl-number.txt``.
112
+26) If any ioctl's are added by the patch, then also update
113
+ ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
114114
115
-26) If your modified source code depends on or uses any of the kernel
115
+27) If your modified source code depends on or uses any of the kernel
116116 APIs or features that are related to the following ``Kconfig`` symbols,
117117 then test multiple builds with the related ``Kconfig`` symbols disabled
118118 and/or ``=m`` (if that option is available) [not all of these at the