submit-checklist.rst (0898782247ae533d1f4e47a06bc5d4870931b284) submit-checklist.rst (72ef5e52b3f74c0be47b20f5c434b7ecc830cf40)
1.. _submitchecklist:
2
3Linux Kernel patch submission checklist
4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6Here are some basic things that developers should do if they want to see their
7kernel patch submissions accepted more quickly.
8

--- 93 unchanged lines hidden (view full) ---

102 that it still works with all of the other queued patches and various
103 changes in the VM, VFS, and other subsystems.
104
10525) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
106 comment in the source code that explains the logic of what they are doing
107 and why.
108
10926) If any ioctl's are added by the patch, then also update
1.. _submitchecklist:
2
3Linux Kernel patch submission checklist
4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6Here are some basic things that developers should do if they want to see their
7kernel patch submissions accepted more quickly.
8

--- 93 unchanged lines hidden (view full) ---

102 that it still works with all of the other queued patches and various
103 changes in the VM, VFS, and other subsystems.
104
10525) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
106 comment in the source code that explains the logic of what they are doing
107 and why.
108
10926) If any ioctl's are added by the patch, then also update
110 ``Documentation/ioctl/ioctl-number.rst``.
110 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
111
11227) If your modified source code depends on or uses any of the kernel
113 APIs or features that are related to the following ``Kconfig`` symbols,
114 then test multiple builds with the related ``Kconfig`` symbols disabled
115 and/or ``=m`` (if that option is available) [not all of these at the
116 same time, just various/random combinations of them]:
117
118 ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``, ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,
119 ``CONFIG_NET``, ``CONFIG_INET=n`` (but latter with ``CONFIG_NET=y``).
111
11227) If your modified source code depends on or uses any of the kernel
113 APIs or features that are related to the following ``Kconfig`` symbols,
114 then test multiple builds with the related ``Kconfig`` symbols disabled
115 and/or ``=m`` (if that option is available) [not all of these at the
116 same time, just various/random combinations of them]:
117
118 ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``, ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,
119 ``CONFIG_NET``, ``CONFIG_INET=n`` (but latter with ``CONFIG_NET=y``).