Documentation/process/submit-checklist.rst

Source file repositories/reference/linux-study-clean/Documentation/process/submit-checklist.rst

File Facts

System
Linux kernel
Corpus path
Documentation/process/submit-checklist.rst
Extension
.rst
Size
5329 bytes
Lines
138
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. _submitchecklist:

=======================================
Linux Kernel patch submission checklist
=======================================

Here are some basic things that developers should do if they want to see their
kernel patch submissions accepted more quickly.

These are all above and beyond the documentation that is provided in
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
and elsewhere regarding submitting Linux kernel patches.

Review your code
================

1) If you use a facility then #include the file that defines/declares
   that facility.  Don't depend on other header files pulling in ones
   that you use.

2) Check your patch for general style as detailed in
   :ref:`Documentation/process/coding-style.rst <codingstyle>`.

3) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
   comment in the source code that explains the logic of what they are doing
   and why.

Review Kconfig changes
======================

1) Any new or modified ``CONFIG`` options do not muck up the config menu and
   default to off unless they meet the exception criteria documented in
   ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.

2) All new ``Kconfig`` options have help text.

3) Has been carefully reviewed with respect to relevant ``Kconfig``
   combinations.  This is very hard to get right with testing---brainpower
   pays off here.

Provide documentation
=====================

1) Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
   (Not required for static functions, but OK there also.)

2) All new ``/proc`` entries are documented under ``Documentation/``

3) All new kernel boot parameters are documented in
   ``Documentation/admin-guide/kernel-parameters.rst``.

4) All new module parameters are documented with ``MODULE_PARM_DESC()``

5) All new userspace interfaces are documented in ``Documentation/ABI/``.
   See Documentation/admin-guide/abi.rst (or ``Documentation/ABI/README``)
   for more information.
   Patches that change userspace interfaces should be CCed to
   linux-api@vger.kernel.org.

6) If any ioctl's are added by the patch, then also update
   ``Documentation/userspace-api/ioctl/ioctl-number.rst``.

Check your code with tools
==========================

1) Check for trivial violations with the patch style checker prior to
   submission (``scripts/checkpatch.pl``).
   You should be able to justify all violations that remain in
   your patch.

Annotation

Implementation Notes