sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget,/translations/zh_CN/process/submit-checklistmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/zh_TW/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/it_IT/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ja_JP/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ko_KR/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/pt_BR/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/sp_SP/process/submit-checklistmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhtarget)}(h.. _submitchecklist:h]h}(h]h ]h"]h$]h&]refidsubmitchecklistuh1hhKhhhhhF/var/lib/git/docbuild/linux/Documentation/process/submit-checklist.rstubhsection)}(hhh](htitle)}(h'Linux Kernel patch submission checklisth]h'Linux Kernel patch submission checklist}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h~Here are some basic things that developers should do if they want to see their kernel patch submissions accepted more quickly.h]h~Here are some basic things that developers should do if they want to see their kernel patch submissions accepted more quickly.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThese are all above and beyond the documentation that is provided in :ref:`Documentation/process/submitting-patches.rst ` and elsewhere regarding submitting Linux kernel patches.h](hEThese are all above and beyond the documentation that is provided in }(hhhhhNhNubh)}(hG:ref:`Documentation/process/submitting-patches.rst `h]hinline)}(hhh]h,Documentation/process/submitting-patches.rst}(hhhhhNhNubah}(h]h ](xrefstdstd-refeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdocprocess/submit-checklist refdomainjreftyperef refexplicitrefwarn reftargetsubmittingpatchesuh1hhhhK hhubh9 and elsewhere regarding submitting Linux kernel patches.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(hReview your codeh]hReview your code}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubhenumerated_list)}(hhh](h list_item)}(hIf 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. h]h)}(hIf 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.h]hIf 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.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj8ubah}(h]h ]h"]h$]h&]uh1j6hj3hhhhhNubj7)}(hoCheck your patch for general style as detailed in :ref:`Documentation/process/coding-style.rst `. h]h)}(hnCheck your patch for general style as detailed in :ref:`Documentation/process/coding-style.rst `.h](h2Check your patch for general style as detailed in }(hjThhhNhNubh)}(h;:ref:`Documentation/process/coding-style.rst `h]h)}(hj^h]h&Documentation/process/coding-style.rst}(hj`hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1hhj\ubah}(h]h ]h"]h$]h&]refdocj refdomainjjreftyperef refexplicitrefwarnj codingstyleuh1hhhhKhjTubh.}(hjThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjPubah}(h]h ]h"]h$]h&]uh1j6hj3hhhhhNubj7)}(hAll 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. h]h)}(hAll 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.h](hAll memory barriers {e.g., }(hjhhhNhNubhliteral)}(h ``barrier()``h]h barrier()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h ``rmb()``h]hrmb()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h ``wmb()``h]hwmb()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh[} need a comment in the source code that explains the logic of what they are doing and why.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j6hj3hhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix)uh1j1hj hhhhhKubeh}(h]review-your-codeah ]h"]review your codeah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hReview Kconfig changesh]hReview Kconfig changes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj2)}(hhh](j7)}(hAny 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. h]h)}(hAny 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.h](hAny new or modified }(hjhhhNhNubj)}(h ``CONFIG``h]hCONFIG}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhq options do not muck up the config menu and default to off unless they meet the exception criteria documented in }(hjhhhNhNubj)}(h-``Documentation/kbuild/kconfig-language.rst``h]h)Documentation/kbuild/kconfig-language.rst}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh Menu attributes: default value.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(h,All new ``Kconfig`` options have help text. h]h)}(h+All new ``Kconfig`` options have help text.h](hAll new }(hjChhhNhNubj)}(h ``Kconfig``h]hKconfig}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubh options have help text.}(hjChhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK#hj?ubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hHas been carefully reviewed with respect to relevant ``Kconfig`` combinations. This is very hard to get right with testing---brainpower pays off here. h]h)}(hHas been carefully reviewed with respect to relevant ``Kconfig`` combinations. This is very hard to get right with testing---brainpower pays off here.h](h5Has been carefully reviewed with respect to relevant }(hjmhhhNhNubj)}(h ``Kconfig``h]hKconfig}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubhW combinations. This is very hard to get right with testing---brainpower pays off here.}(hjmhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK%hjiubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubeh}(h]h ]h"]h$]h&]jjjhjjuh1j1hjhhhhhKubeh}(h]review-kconfig-changesah ]h"]review kconfig changesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hProvide documentationh]hProvide documentation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK*ubj2)}(hhh](j7)}(hInclude :ref:`kernel-doc ` to document global kernel APIs. (Not required for static functions, but OK there also.) h]h)}(h~Include :ref:`kernel-doc ` to document global kernel APIs. (Not required for static functions, but OK there also.)h](hInclude }(hjhhhNhNubh)}(h:ref:`kernel-doc `h]h)}(hjh]h kernel-doc}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj kernel_docuh1hhhhK,hjubhX to document global kernel APIs. (Not required for static functions, but OK there also.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK,hjubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hBAll new ``/proc`` entries are documented under ``Documentation/`` h]h)}(hAAll new ``/proc`` entries are documented under ``Documentation/``h](hAll new }(hjhhhNhNubj)}(h ``/proc``h]h/proc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh entries are documented under }(hjhhhNhNubj)}(h``Documentation/``h]hDocumentation/}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhhhK/hjubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hfAll new kernel boot parameters are documented in ``Documentation/admin-guide/kernel-parameters.rst``. h]h)}(heAll new kernel boot parameters are documented in ``Documentation/admin-guide/kernel-parameters.rst``.h](h1All new kernel boot parameters are documented in }(hj-hhhNhNubj)}(h3``Documentation/admin-guide/kernel-parameters.rst``h]h/Documentation/admin-guide/kernel-parameters.rst}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubh.}(hj-hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK1hj)ubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hEAll new module parameters are documented with ``MODULE_PARM_DESC()`` h]h)}(hDAll new module parameters are documented with ``MODULE_PARM_DESC()``h](h.All new module parameters are documented with }(hjWhhhNhNubj)}(h``MODULE_PARM_DESC()``h]hMODULE_PARM_DESC()}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1hhhhK4hjSubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hAll 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. h]h)}(hAll 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.h](h/All new userspace interfaces are documented in }(hj}hhhNhNubj)}(h``Documentation/ABI/``h]hDocumentation/ABI/}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubh,. See Documentation/admin-guide/abi.rst (or }(hj}hhhNhNubj)}(h``Documentation/ABI/README``h]hDocumentation/ABI/README}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubhS) for more information. Patches that change userspace interfaces should be CCed to }(hj}hhhNhNubh reference)}(hlinux-api@vger.kernel.orgh]hlinux-api@vger.kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refuri mailto:linux-api@vger.kernel.orguh1jhj}ubh.}(hj}hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK6hjyubah}(h]h ]h"]h$]h&]uh1j6hjhhhhhNubj7)}(hpIf any ioctl's are added by the patch, then also update ``Documentation/userspace-api/ioctl/ioctl-number.rst``. h]h)}(hoIf any ioctl's are added by the patch, then also update ``Documentation/userspace-api/ioctl/ioctl-number.rst``.h](h:If any ioctl’s are added by the patch, then also update }(hjhhhNhNubj)}(h6``Documentation/userspace-api/ioctl/ioctl-number.rst``h]h2Documentation/userspace-api/ioctl/ioctl-number.rst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKEnumerated list start value not ordinal-1: “2” (ordinal 2)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~ ubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehÌlineKuh1j| hjhhhhhK^ubatransform_messages]j} )}(hhh]h)}(hhh]h5Hyperlink target "submitchecklist" is not referenced.}hj sbah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]levelKtypej sourcehÌlineKuh1j| uba transformerN include_log] decorationNhhub.