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/dev-tools/checkpatchmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/zh_TW/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/it_IT/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ja_JP/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ko_KR/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/pt_BR/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/sp_SP/dev-tools/checkpatchmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h%SPDX-License-Identifier: GPL-2.0-onlyh]h%SPDX-License-Identifier: GPL-2.0-only}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhB/var/lib/git/docbuild/linux/Documentation/dev-tools/checkpatch.rsthKubhsection)}(hhh](htitle)}(h Checkpatchh]h Checkpatch}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hCheckpatch (scripts/checkpatch.pl) is a perl script which checks for trivial style violations in patches and optionally corrects them. Checkpatch can also be run on file contexts and without the kernel tree.h]hCheckpatch (scripts/checkpatch.pl) is a perl script which checks for trivial style violations in patches and optionally corrects them. Checkpatch can also be run on file contexts and without the kernel tree.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hCheckpatch is not always right. Your judgement takes precedence over checkpatch messages. If your code looks better with the violations, then its probably best left alone.h]hCheckpatch is not always right. Your judgement takes precedence over checkpatch messages. If your code looks better with the violations, then its probably best left alone.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(hOptionsh]hOptions}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hBThis section will describe the options checkpatch can be run with.h]hBThis section will describe the options checkpatch can be run with.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hUsage::h]hUsage:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh literal_block)}(h-./scripts/checkpatch.pl [OPTION]... [FILE]...h]h-./scripts/checkpatch.pl [OPTION]... [FILE]...}hj*sbah}(h]h ]h"]h$]h&]hhuh1j(hhhKhhhhubh)}(hAvailable options:h]hAvailable options:}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh block_quote)}(hX=- -q, --quiet Enable quiet mode. - -v, --verbose Enable verbose mode. Additional verbose test descriptions are output so as to provide information on why that particular message is shown. - --no-tree Run checkpatch without the kernel tree. - --no-signoff Disable the 'Signed-off-by' line check. The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. Example:: Signed-off-by: Random J Developer Setting this flag effectively stops a message for a missing signed-off-by line in a patch context. - --patch Treat FILE as a patch. This is the default option and need not be explicitly specified. - --emacs Set output to emacs compile window format. This allows emacs users to jump from the error in the compile window directly to the offending line in the patch. - --terse Output only one line per report. - --showfile Show the diffed file position instead of the input file position. - -g, --git Treat FILE as a single commit or a git revision range. Single commit with: - - ^ - ~n Multiple commits with: - .. - ... - - - -f, --file Treat FILE as a regular source file. This option must be used when running checkpatch on source files in the kernel. - --subjective, --strict Enable stricter tests in checkpatch. By default the tests emitted as CHECK do not activate by default. Use this flag to activate the CHECK tests. - --list-types Every message emitted by checkpatch has an associated TYPE. Add this flag to display all the types in checkpatch. Note that when this flag is active, checkpatch does not read the input FILE, and no message is emitted. Only a list of types in checkpatch is output. - --types TYPE(,TYPE2...) Only display messages with the given types. Example:: ./scripts/checkpatch.pl mypatch.patch --types EMAIL_SUBJECT,BRACES - --ignore TYPE(,TYPE2...) Checkpatch will not emit messages for the specified types. Example:: ./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACES - --show-types By default checkpatch doesn't display the type associated with the messages. Set this flag to show the message type in the output. - --max-line-length=n Set the max line length (default 100). If a line exceeds the specified length, a LONG_LINE message is emitted. The message level is different for patch and file contexts. For patches, a WARNING is emitted. While a milder CHECK is emitted for files. So for file contexts, the --strict flag must also be enabled. - --min-conf-desc-length=n Set the Kconfig entry minimum description length, if shorter, warn. - --tab-size=n Set the number of spaces for tab (default 8). - --root=PATH PATH to the kernel tree root. This option must be specified when invoking checkpatch from outside the kernel root. - --no-summary Suppress the per file summary. - --mailback Only produce a report in case of Warnings or Errors. Milder Checks are excluded from this. - --summary-file Include the filename in summary. - --debug KEY=[0|1] Turn on/off debugging of KEY, where KEY is one of 'values', 'possible', 'type', and 'attr' (default is all off). - --fix This is an EXPERIMENTAL feature. If correctable errors exist, a file .EXPERIMENTAL-checkpatch-fixes is created which has the automatically fixable errors corrected. - --fix-inplace EXPERIMENTAL - Similar to --fix but input file is overwritten with fixes. DO NOT USE this flag unless you are absolutely sure and you have a backup in place. - --ignore-perl-version Override checking of perl version. Runtime errors may be encountered after enabling this flag if the perl version does not meet the minimum specified. - --spdx-cxx-comments Don't force C comments ``/* */`` for SPDX license (required by old toolchains), allow also C++ comments ``//``. NOTE: it should *not* be used for Linux mainline. - --codespell Use the codespell dictionary for checking spelling errors. - --codespellfile Use the specified codespell file. Default is '/usr/share/codespell/dictionary.txt'. - --typedefsfile Read additional types from this file. - --color[=WHEN] Use colors 'always', 'never', or only when output is a terminal ('auto'). Default is 'auto'. - --kconfig-prefix=WORD Use WORD as a prefix for Kconfig symbols (default is `CONFIG_`). - -h, --help, --version Display the help text. h]h bullet_list)}(hhh](h list_item)}(h!-q, --quiet Enable quiet mode. h](h)}(h -q, --quieth]h -q, --quiet}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjSubh)}(hEnable quiet mode.h]hEnable quiet mode.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjSubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h-v, --verbose Enable verbose mode. Additional verbose test descriptions are output so as to provide information on why that particular message is shown. h]h)}(h-v, --verbose Enable verbose mode. Additional verbose test descriptions are output so as to provide information on why that particular message is shown.h]h-v, --verbose Enable verbose mode. Additional verbose test descriptions are output so as to provide information on why that particular message is shown.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyubah}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h3--no-tree Run checkpatch without the kernel tree. h](h)}(h --no-treeh]h --no-tree}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK#hjubh)}(h'Run checkpatch without the kernel tree.h]h'Run checkpatch without the kernel tree.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK%hjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hX--no-signoff Disable the 'Signed-off-by' line check. The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. Example:: Signed-off-by: Random J Developer Setting this flag effectively stops a message for a missing signed-off-by line in a patch context. h](h)}(h --no-signoffh]h --no-signoff}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK'hjubh)}(hDisable the 'Signed-off-by' line check. The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.h]hDisable the ‘Signed-off-by’ line check. The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK)hjubh)}(h Example::h]hExample:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hjubj))}(h@Signed-off-by: Random J Developer h]h@Signed-off-by: Random J Developer }hjsbah}(h]h ]h"]h$]h&]hhuh1j(hhhK/hjubh)}(hbSetting this flag effectively stops a message for a missing signed-off-by line in a patch context.h]hbSetting this flag effectively stops a message for a missing signed-off-by line in a patch context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK1hjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hb--patch Treat FILE as a patch. This is the default option and need not be explicitly specified. h](h)}(h--patchh]h--patch}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjubh)}(hXTreat FILE as a patch. This is the default option and need not be explicitly specified.h]hXTreat FILE as a patch. This is the default option and need not be explicitly specified.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK6hjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--emacs Set output to emacs compile window format. This allows emacs users to jump from the error in the compile window directly to the offending line in the patch. h](h)}(h--emacsh]h--emacs}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hj-ubh)}(hSet output to emacs compile window format. This allows emacs users to jump from the error in the compile window directly to the offending line in the patch.h]hSet output to emacs compile window format. This allows emacs users to jump from the error in the compile window directly to the offending line in the patch.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK;hj-ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h*--terse Output only one line per report. h](h)}(h--terseh]h--terse}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK?hjSubh)}(h Output only one line per report.h]h Output only one line per report.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjSubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hN--showfile Show the diffed file position instead of the input file position. h](h)}(h --showfileh]h --showfile}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjyubh)}(hAShow the diffed file position instead of the input file position.h]hAShow the diffed file position instead of the input file position.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKEhjyubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h-g, --git Treat FILE as a single commit or a git revision range. Single commit with: - - ^ - ~n Multiple commits with: - .. - ... - - h](h)}(h -g, --gith]h -g, --git}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhjubh)}(h6Treat FILE as a single commit or a git revision range.h]h6Treat FILE as a single commit or a git revision range.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjubh)}(hSingle commit with:h]hSingle commit with:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKKhjubjM)}(hhh](jR)}(hh]h)}(hjh]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKMhjubah}(h]h ]h"]h$]h&]uh1jQhjubjR)}(h^h]h)}(hjh]h^}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKNhjubah}(h]h ]h"]h$]h&]uh1jQhjubjR)}(h~n h]h)}(h~nh]h~n}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKOhjubah}(h]h ]h"]h$]h&]uh1jQhjubeh}(h]h ]h"]h$]h&]bullet-uh1jLhhhKMhjubh)}(hMultiple commits with:h]hMultiple commits with:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKQhjubjM)}(hhh](jR)}(h..h]h)}(hj1h]h..}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKShj/ubah}(h]h ]h"]h$]h&]uh1jQhj,ubjR)}(h...h]h)}(hjHh]h...}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjFubah}(h]h ]h"]h$]h&]uh1jQhj,ubjR)}(h- h]h)}(h -h]h -}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKUhj]ubah}(h]h ]h"]h$]h&]uh1jQhj,ubeh}(h]h ]h"]h$]h&]jjuh1jLhhhKShjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h-f, --file Treat FILE as a regular source file. This option must be used when running checkpatch on source files in the kernel. h](h)}(h -f, --fileh]h -f, --file}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKWhjubh)}(huTreat FILE as a regular source file. This option must be used when running checkpatch on source files in the kernel.h]huTreat FILE as a regular source file. This option must be used when running checkpatch on source files in the kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKYhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--subjective, --strict Enable stricter tests in checkpatch. By default the tests emitted as CHECK do not activate by default. Use this flag to activate the CHECK tests. h](h)}(h--subjective, --stricth]h--subjective, --strict}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK\hjubh)}(hEnable stricter tests in checkpatch. By default the tests emitted as CHECK do not activate by default. Use this flag to activate the CHECK tests.h]hEnable stricter tests in checkpatch. By default the tests emitted as CHECK do not activate by default. Use this flag to activate the CHECK tests.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK^hjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hX--list-types Every message emitted by checkpatch has an associated TYPE. Add this flag to display all the types in checkpatch. Note that when this flag is active, checkpatch does not read the input FILE, and no message is emitted. Only a list of types in checkpatch is output. h](h)}(h --list-typesh]h --list-types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKahjubh)}(hrEvery message emitted by checkpatch has an associated TYPE. Add this flag to display all the types in checkpatch.h]hrEvery message emitted by checkpatch has an associated TYPE. Add this flag to display all the types in checkpatch.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKchjubh)}(hNote that when this flag is active, checkpatch does not read the input FILE, and no message is emitted. Only a list of types in checkpatch is output.h]hNote that when this flag is active, checkpatch does not read the input FILE, and no message is emitted. Only a list of types in checkpatch is output.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKfhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--types TYPE(,TYPE2...) Only display messages with the given types. Example:: ./scripts/checkpatch.pl mypatch.patch --types EMAIL_SUBJECT,BRACES h](h)}(h--types TYPE(,TYPE2...)h]h--types TYPE(,TYPE2...)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKihjubh)}(h+Only display messages with the given types.h]h+Only display messages with the given types.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKkhjubh)}(h Example::h]hExample:}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKmhjubj))}(hB./scripts/checkpatch.pl mypatch.patch --types EMAIL_SUBJECT,BRACESh]hB./scripts/checkpatch.pl mypatch.patch --types EMAIL_SUBJECT,BRACES}hj/sbah}(h]h ]h"]h$]h&]hhuh1j(hhhKohjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--ignore TYPE(,TYPE2...) Checkpatch will not emit messages for the specified types. Example:: ./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACES h](h)}(h--ignore TYPE(,TYPE2...)h]h--ignore TYPE(,TYPE2...)}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhjCubh)}(h:Checkpatch will not emit messages for the specified types.h]h:Checkpatch will not emit messages for the specified types.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKshjCubh)}(h Example::h]hExample:}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhjCubj))}(hC./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACESh]hC./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACES}hjqsbah}(h]h ]h"]h$]h&]hhuh1j(hhhKwhjCubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--show-types By default checkpatch doesn't display the type associated with the messages. Set this flag to show the message type in the output. h](h)}(h --show-typesh]h --show-types}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKyhjubh)}(hBy default checkpatch doesn't display the type associated with the messages. Set this flag to show the message type in the output.h]hBy default checkpatch doesn’t display the type associated with the messages. Set this flag to show the message type in the output.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK{hjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hXR--max-line-length=n Set the max line length (default 100). If a line exceeds the specified length, a LONG_LINE message is emitted. The message level is different for patch and file contexts. For patches, a WARNING is emitted. While a milder CHECK is emitted for files. So for file contexts, the --strict flag must also be enabled. h](h)}(h--max-line-length=nh]h--max-line-length=n}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK~hjubh)}(hoSet the max line length (default 100). If a line exceeds the specified length, a LONG_LINE message is emitted.h]hoSet the max line length (default 100). If a line exceeds the specified length, a LONG_LINE message is emitted.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hThe message level is different for patch and file contexts. For patches, a WARNING is emitted. While a milder CHECK is emitted for files. So for file contexts, the --strict flag must also be enabled.h]hThe message level is different for patch and file contexts. For patches, a WARNING is emitted. While a milder CHECK is emitted for files. So for file contexts, the --strict flag must also be enabled.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h^--min-conf-desc-length=n Set the Kconfig entry minimum description length, if shorter, warn. h](h)}(h--min-conf-desc-length=nh]h--min-conf-desc-length=n}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hCSet the Kconfig entry minimum description length, if shorter, warn.h]hCSet the Kconfig entry minimum description length, if shorter, warn.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h<--tab-size=n Set the number of spaces for tab (default 8). h](h)}(h --tab-size=nh]h --tab-size=n}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h-Set the number of spaces for tab (default 8).h]h-Set the number of spaces for tab (default 8).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--root=PATH PATH to the kernel tree root. This option must be specified when invoking checkpatch from outside the kernel root. h](h)}(h --root=PATHh]h --root=PATH}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj+ubh)}(hPATH to the kernel tree root.h]hPATH to the kernel tree root.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj+ubh)}(hTThis option must be specified when invoking checkpatch from outside the kernel root.h]hTThis option must be specified when invoking checkpatch from outside the kernel root.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj+ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h---no-summary Suppress the per file summary. h](h)}(h --no-summaryh]h --no-summary}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj_ubh)}(hSuppress the per file summary.h]hSuppress the per file summary.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj_ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hh--mailback Only produce a report in case of Warnings or Errors. Milder Checks are excluded from this. h](h)}(h --mailbackh]h --mailback}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h[Only produce a report in case of Warnings or Errors. Milder Checks are excluded from this.h]h[Only produce a report in case of Warnings or Errors. Milder Checks are excluded from this.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h1--summary-file Include the filename in summary. h](h)}(h--summary-fileh]h--summary-file}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h Include the filename in summary.h]h Include the filename in summary.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--debug KEY=[0|1] Turn on/off debugging of KEY, where KEY is one of 'values', 'possible', 'type', and 'attr' (default is all off). h](h)}(h--debug KEY=[0|1]h]h--debug KEY=[0|1]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hpTurn on/off debugging of KEY, where KEY is one of 'values', 'possible', 'type', and 'attr' (default is all off).h]hTurn on/off debugging of KEY, where KEY is one of ‘values’, ‘possible’, ‘type’, and ‘attr’ (default is all off).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--fix This is an EXPERIMENTAL feature. If correctable errors exist, a file .EXPERIMENTAL-checkpatch-fixes is created which has the automatically fixable errors corrected. h](h)}(h--fixh]h--fix}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hThis is an EXPERIMENTAL feature. If correctable errors exist, a file .EXPERIMENTAL-checkpatch-fixes is created which has the automatically fixable errors corrected.h]hThis is an EXPERIMENTAL feature. If correctable errors exist, a file .EXPERIMENTAL-checkpatch-fixes is created which has the automatically fixable errors corrected.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--fix-inplace EXPERIMENTAL - Similar to --fix but input file is overwritten with fixes. DO NOT USE this flag unless you are absolutely sure and you have a backup in place. h](h)}(h --fix-inplaceh]h --fix-inplace}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hIEXPERIMENTAL - Similar to --fix but input file is overwritten with fixes.h]hIEXPERIMENTAL - Similar to --fix but input file is overwritten with fixes.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hSDO NOT USE this flag unless you are absolutely sure and you have a backup in place.h]hSDO NOT USE this flag unless you are absolutely sure and you have a backup in place.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--ignore-perl-version Override checking of perl version. Runtime errors may be encountered after enabling this flag if the perl version does not meet the minimum specified. h](h)}(h--ignore-perl-versionh]h--ignore-perl-version}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjQubh)}(hOverride checking of perl version. Runtime errors may be encountered after enabling this flag if the perl version does not meet the minimum specified.h]hOverride checking of perl version. Runtime errors may be encountered after enabling this flag if the perl version does not meet the minimum specified.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjQubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h--spdx-cxx-comments Don't force C comments ``/* */`` for SPDX license (required by old toolchains), allow also C++ comments ``//``. NOTE: it should *not* be used for Linux mainline. h](h)}(h--spdx-cxx-commentsh]h--spdx-cxx-comments}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjwubh)}(hoDon't force C comments ``/* */`` for SPDX license (required by old toolchains), allow also C++ comments ``//``.h](hDon’t force C comments }(hjhhhNhNubhliteral)}(h ``/* */``h]h/* */}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhH for SPDX license (required by old toolchains), allow also C++ comments }(hjhhhNhNubj)}(h``//``h]h//}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjwubh)}(h1NOTE: it should *not* be used for Linux mainline.h](hNOTE: it should }(hjhhhNhNubhemphasis)}(h*not*h]hnot}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh be used for Linux mainline.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjwubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hH--codespell Use the codespell dictionary for checking spelling errors. h](h)}(h --codespellh]h --codespell}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h:Use the codespell dictionary for checking spelling errors.h]h:Use the codespell dictionary for checking spelling errors.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(he--codespellfile Use the specified codespell file. Default is '/usr/share/codespell/dictionary.txt'. h](h)}(h--codespellfileh]h--codespellfile}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hSUse the specified codespell file. Default is '/usr/share/codespell/dictionary.txt'.h]hWUse the specified codespell file. Default is ‘/usr/share/codespell/dictionary.txt’.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h6--typedefsfile Read additional types from this file. h](h)}(h--typedefsfileh]h--typedefsfile}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj1ubh)}(h%Read additional types from this file.h]h%Read additional types from this file.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj1ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hm--color[=WHEN] Use colors 'always', 'never', or only when output is a terminal ('auto'). Default is 'auto'. h](h)}(h--color[=WHEN]h]h--color[=WHEN]}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjWubh)}(h\Use colors 'always', 'never', or only when output is a terminal ('auto'). Default is 'auto'.h]hlUse colors ‘always’, ‘never’, or only when output is a terminal (‘auto’). Default is ‘auto’.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjWubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(hX--kconfig-prefix=WORD Use WORD as a prefix for Kconfig symbols (default is `CONFIG_`). h](h)}(h--kconfig-prefix=WORDh]h--kconfig-prefix=WORD}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj}ubh)}(h@Use WORD as a prefix for Kconfig symbols (default is `CONFIG_`).h](h5Use WORD as a prefix for Kconfig symbols (default is }(hjhhhNhNubhtitle_reference)}(h `CONFIG_`h]hCONFIG_}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj}ubeh}(h]h ]h"]h$]h&]uh1jQhjNubjR)}(h.-h, --help, --version Display the help text. h](h)}(h-h, --help, --versionh]h-h, --help, --version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hDisplay the help text.h]hDisplay the help text.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjNubeh}(h]h ]h"]h$]h&]jjuh1jLhhhKhjHubah}(h]h ]h"]h$]h&]uh1jFhhhKhhhhubeh}(h]optionsah ]h"]optionsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hConfiguration fileh]hConfiguration file}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hDefault configuration options can be stored in ``.checkpatch.conf``, search path: ``.:$HOME:.scripts`` or in a directory specified by ``$CHECKPATCH_CONFIG_DIR`` environment variable (falling back to the default search path).h](h/Default configuration options can be stored in }(hjhhhNhNubj)}(h``.checkpatch.conf``h]h.checkpatch.conf}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, search path: }(hjhhhNhNubj)}(h``.:$HOME:.scripts``h]h.:$HOME:.scripts}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh or in a directory specified by }(hjhhhNhNubj)}(h``$CHECKPATCH_CONFIG_DIR``h]h$CHECKPATCH_CONFIG_DIR}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh@ environment variable (falling back to the default search path).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]configuration-fileah ]h"]configuration fileah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hMessage Levelsh]hMessage Levels}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNhhhhhKubh)}(hMessages in checkpatch are divided into three levels. The levels of messages in checkpatch denote the severity of the error. They are:h]hMessages in checkpatch are divided into three levels. The levels of messages in checkpatch denote the severity of the error. They are:}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjNhhubjG)}(hXy- ERROR This is the most strict level. Messages of type ERROR must be taken seriously as they denote things that are very likely to be wrong. - WARNING This is the next stricter level. Messages of type WARNING requires a more careful review. But it is milder than an ERROR. - CHECK This is the mildest level. These are things which may require some thought. h]jM)}(hhh](jR)}(hERROR This is the most strict level. Messages of type ERROR must be taken seriously as they denote things that are very likely to be wrong. h](h)}(hERRORh]hERROR}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubh)}(hThis is the most strict level. Messages of type ERROR must be taken seriously as they denote things that are very likely to be wrong.h]hThis is the most strict level. Messages of type ERROR must be taken seriously as they denote things that are very likely to be wrong.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubeh}(h]h ]h"]h$]h&]uh1jQhjqubjR)}(hWARNING This is the next stricter level. Messages of type WARNING requires a more careful review. But it is milder than an ERROR. h](h)}(hWARNINGh]hWARNING}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h{This is the next stricter level. Messages of type WARNING requires a more careful review. But it is milder than an ERROR.h]h{This is the next stricter level. Messages of type WARNING requires a more careful review. But it is milder than an ERROR.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjqubjR)}(hTCHECK This is the mildest level. These are things which may require some thought. h](h)}(hCHECKh]hCHECK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hLThis is the mildest level. These are things which may require some thought.h]hLThis is the mildest level. These are things which may require some thought.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jQhjqubeh}(h]h ]h"]h$]h&]jjuh1jLhhhKhjmubah}(h]h ]h"]h$]h&]uh1jFhhhKhjNhhubeh}(h]message-levelsah ]h"]message levelsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hType Descriptionsh]hType Descriptions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hKThis section contains a description of all the message types in checkpatch.h]hKThis section contains a description of all the message types in checkpatch.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h4Types in this section are also parsed by checkpatch.h]h4Types in this section are also parsed by checkpatch.}hj sbah}(h]h ]h"]h$]h&]hhuh1hhjhhhhhKubh)}(h4The types are grouped into subsections based on use.h]h4The types are grouped into subsections based on use.}hj' sbah}(h]h ]h"]h$]h&]hhuh1hhjhhhhhKubh)}(hhh](h)}(hAllocation styleh]hAllocation style}(hj8 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5 hhhhhMubjG)}(hX**ALLOC_ARRAY_ARGS** The first argument for kcalloc or kmalloc_array should be the number of elements. sizeof() as the first argument is generally wrong. See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html **ALLOC_SIZEOF_STRUCT** The allocation style is bad. In general for family of allocation functions using sizeof() to get memory size, constructs like:: p = alloc(sizeof(struct foo), ...) should be:: p = alloc(sizeof(*p), ...) See: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory **ALLOC_WITH_MULTIPLY** Prefer kmalloc_array/kcalloc over kmalloc/kzalloc with a sizeof multiply. See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html h]hdefinition_list)}(hhh](hdefinition_list_item)}(h**ALLOC_ARRAY_ARGS** The first argument for kcalloc or kmalloc_array should be the number of elements. sizeof() as the first argument is generally wrong. See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html h](hterm)}(h**ALLOC_ARRAY_ARGS**h]hstrong)}(hjY h]hALLOC_ARRAY_ARGS}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjW ubah}(h]h ]h"]h$]h&]uh1jU hhhMhjQ ubh definition)}(hhh](h)}(hThe first argument for kcalloc or kmalloc_array should be the number of elements. sizeof() as the first argument is generally wrong.h]hThe first argument for kcalloc or kmalloc_array should be the number of elements. sizeof() as the first argument is generally wrong.}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjr ubh)}(hKSee: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.htmlh](hSee: }(hj hhhNhNubh reference)}(hFhttps://www.kernel.org/doc/html/latest/core-api/memory-allocation.htmlh]hFhttps://www.kernel.org/doc/html/latest/core-api/memory-allocation.html}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjr ubeh}(h]h ]h"]h$]h&]uh1jp hjQ ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhjL ubjP )}(hXC**ALLOC_SIZEOF_STRUCT** The allocation style is bad. In general for family of allocation functions using sizeof() to get memory size, constructs like:: p = alloc(sizeof(struct foo), ...) should be:: p = alloc(sizeof(*p), ...) See: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory h](jV )}(h**ALLOC_SIZEOF_STRUCT**h]j\ )}(hj h]hALLOC_SIZEOF_STRUCT}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhMhj ubjq )}(hhh](h)}(hThe allocation style is bad. In general for family of allocation functions using sizeof() to get memory size, constructs like::h]hThe allocation style is bad. In general for family of allocation functions using sizeof() to get memory size, constructs like:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj ubj))}(h"p = alloc(sizeof(struct foo), ...)h]h"p = alloc(sizeof(struct foo), ...)}hj sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMhj ubh)}(h should be::h]h should be:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj))}(hp = alloc(sizeof(*p), ...)h]hp = alloc(sizeof(*p), ...)}hj sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMhj ubh)}(hWSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memoryh](hSee: }(hj hhhNhNubj )}(hRhttps://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memoryh]hRhttps://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhjL ubjP )}(h**ALLOC_WITH_MULTIPLY** Prefer kmalloc_array/kcalloc over kmalloc/kzalloc with a sizeof multiply. See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html h](jV )}(h**ALLOC_WITH_MULTIPLY**h]j\ )}(hj3 h]hALLOC_WITH_MULTIPLY}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj1 ubah}(h]h ]h"]h$]h&]uh1jU hhhMhj- ubjq )}(hhh](h)}(hIPrefer kmalloc_array/kcalloc over kmalloc/kzalloc with a sizeof multiply.h]hIPrefer kmalloc_array/kcalloc over kmalloc/kzalloc with a sizeof multiply.}(hjK hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjH ubh)}(hKSee: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.htmlh](hSee: }(hjY hhhNhNubj )}(hFhttps://www.kernel.org/doc/html/latest/core-api/memory-allocation.htmlh]hFhttps://www.kernel.org/doc/html/latest/core-api/memory-allocation.html}(hja hhhNhNubah}(h]h ]h"]h$]h&]refurijc uh1j hjY ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjH ubeh}(h]h ]h"]h$]h&]uh1jp hj- ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhjL ubeh}(h]h ]h"]h$]h&]uh1jJ hjF ubah}(h]h ]h"]h$]h&]uh1jFhhhMhj5 hhubeh}(h]allocation-styleah ]h"]allocation styleah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(h API usageh]h API usage}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubjG)}(hXm**ARCH_DEFINES** Architecture specific defines should be avoided wherever possible. **ARCH_INCLUDE_LINUX** Whenever asm/file.h is included and linux/file.h exists, a conversion can be made when linux/file.h includes asm/file.h. However this is not always the case (See signal.h). This message type is emitted only for includes from arch/. **AVOID_BUG** BUG() or BUG_ON() should be avoided totally. Use WARN() and WARN_ON() instead, and handle the "impossible" error condition as gracefully as possible. See: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on **CONSIDER_KSTRTO** The simple_strtol(), simple_strtoll(), simple_strtoul(), and simple_strtoull() functions explicitly ignore overflows, which may lead to unexpected results in callers. The respective kstrtol(), kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the correct replacements. See: https://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoull **CONSTANT_CONVERSION** Use of __constant_ form is discouraged for the following functions:: __constant_cpu_to_be[x] __constant_cpu_to_le[x] __constant_be[x]_to_cpu __constant_le[x]_to_cpu __constant_htons __constant_ntohs Using any of these outside of include/uapi/ is not preferred as using the function without __constant_ is identical when the argument is a constant. In big endian systems, the macros like __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to the same expression:: #define __constant_cpu_to_be32(x) ((__force __be32)(__u32)(x)) #define __cpu_to_be32(x) ((__force __be32)(__u32)(x)) In little endian systems, the macros __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to __constant_swab32 and __swab32. __swab32 has a __builtin_constant_p check:: #define __swab32(x) \ (__builtin_constant_p((__u32)(x)) ? \ ___constant_swab32(x) : \ __fswab32(x)) So ultimately they have a special case for constants. Similar is the case with all of the macros in the list. Thus using the __constant_... forms are unnecessarily verbose and not preferred outside of include/uapi. See: https://lore.kernel.org/lkml/1400106425.12666.6.camel@joe-AO725/ **DEPRECATED_API** Usage of a deprecated RCU API is detected. It is recommended to replace old flavourful RCU APIs by their new vanilla-RCU counterparts. The full list of available RCU APIs can be viewed from the kernel docs. See: https://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apis **DEVICE_ATTR_FUNCTIONS** The function names used in DEVICE_ATTR is unusual. Typically, the store and show functions are used with _store and _show, where is a named attribute variable of the device. Consider the following examples:: static DEVICE_ATTR(type, 0444, type_show, NULL); static DEVICE_ATTR(power, 0644, power_show, power_store); The function names should preferably follow the above pattern. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes **DEVICE_ATTR_RO** The DEVICE_ATTR_RO(name) helper macro can be used instead of DEVICE_ATTR(name, 0444, name_show, NULL); Note that the macro automatically appends _show to the named attribute variable of the device for the show method. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes **DEVICE_ATTR_RW** The DEVICE_ATTR_RW(name) helper macro can be used instead of DEVICE_ATTR(name, 0644, name_show, name_store); Note that the macro automatically appends _show and _store to the named attribute variable of the device for the show and store methods. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes **DEVICE_ATTR_WO** The DEVICE_AATR_WO(name) helper macro can be used instead of DEVICE_ATTR(name, 0200, NULL, name_store); Note that the macro automatically appends _store to the named attribute variable of the device for the store method. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes **DUPLICATED_SYSCTL_CONST** Commit d91bff3011cf ("proc/sysctl: add shared variables for range check") added some shared const variables to be used instead of a local copy in each source file. Consider replacing the sysctl range checking value with the shared one in include/linux/sysctl.h. The following conversion scheme may be used:: &zero -> SYSCTL_ZERO &one -> SYSCTL_ONE &int_max -> SYSCTL_INT_MAX See: 1. https://lore.kernel.org/lkml/20190430180111.10688-1-mcroce@redhat.com/ 2. https://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/ **ENOSYS** ENOSYS means that a nonexistent system call was called. Earlier, it was wrongly used for things like invalid operations on otherwise valid syscalls. This should be avoided in new code. See: https://lore.kernel.org/lkml/5eb299021dec23c1a48fa7d9f2c8b794e967766d.1408730669.git.luto@amacapital.net/ **ENOTSUPP** ENOTSUPP is not a standard error code and should be avoided in new patches. EOPNOTSUPP should be used instead. See: https://lore.kernel.org/netdev/20200510182252.GA411829@lunn.ch/ **EXPORT_SYMBOL** EXPORT_SYMBOL should immediately follow the symbol to be exported. **IN_ATOMIC** in_atomic() is not for driver use so any such use is reported as an ERROR. Also in_atomic() is often used to determine if sleeping is permitted, but it is not reliable in this use model. Therefore its use is strongly discouraged. However, in_atomic() is ok for core kernel use. See: https://lore.kernel.org/lkml/20080320201723.b87b3732.akpm@linux-foundation.org/ **LOCKDEP** The lockdep_no_validate class was added as a temporary measure to prevent warnings on conversion of device->sem to device->mutex. It should not be used for any other purpose. See: https://lore.kernel.org/lkml/1268959062.9440.467.camel@laptop/ **MALFORMED_INCLUDE** The #include statement has a malformed path. This has happened because the author has included a double slash "//" in the pathname accidentally. **USE_LOCKDEP** lockdep_assert_held() annotations should be preferred over assertions based on spin_is_locked() See: https://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotations **UAPI_INCLUDE** No #include statements in include/uapi should use a uapi/ path. **USLEEP_RANGE** usleep_range() should be preferred over udelay(). The proper way of using usleep_range() is mentioned in the kernel docs. h]jK )}(hhh](jP )}(hT**ARCH_DEFINES** Architecture specific defines should be avoided wherever possible. h](jV )}(h**ARCH_DEFINES**h]j\ )}(hj h]h ARCH_DEFINES}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhM#hj ubjq )}(hhh]h)}(hBArchitecture specific defines should be avoided wherever possible.h]hBArchitecture specific defines should be avoided wherever possible.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj ubah}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhM#hj ubjP )}(h**ARCH_INCLUDE_LINUX** Whenever asm/file.h is included and linux/file.h exists, a conversion can be made when linux/file.h includes asm/file.h. However this is not always the case (See signal.h). This message type is emitted only for includes from arch/. h](jV )}(h**ARCH_INCLUDE_LINUX**h]j\ )}(hj h]hARCH_INCLUDE_LINUX}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhM)hj ubjq )}(hhh]h)}(hWhenever asm/file.h is included and linux/file.h exists, a conversion can be made when linux/file.h includes asm/file.h. However this is not always the case (See signal.h). This message type is emitted only for includes from arch/.h]hWhenever asm/file.h is included and linux/file.h exists, a conversion can be made when linux/file.h includes asm/file.h. However this is not always the case (See signal.h). This message type is emitted only for includes from arch/.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hj ubah}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhM)hj ubjP )}(h**AVOID_BUG** BUG() or BUG_ON() should be avoided totally. Use WARN() and WARN_ON() instead, and handle the "impossible" error condition as gracefully as possible. See: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on h](jV )}(h **AVOID_BUG**h]j\ )}(hj$ h]h AVOID_BUG}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj" ubah}(h]h ]h"]h$]h&]uh1jU hhhM0hj ubjq )}(hhh](h)}(hBUG() or BUG_ON() should be avoided totally. Use WARN() and WARN_ON() instead, and handle the "impossible" error condition as gracefully as possible.h]hBUG() or BUG_ON() should be avoided totally. Use WARN() and WARN_ON() instead, and handle the “impossible” error condition as gracefully as possible.}(hj< hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM,hj9 ubh)}(hRSee: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-onh](hSee: }(hjJ hhhNhNubj )}(hMhttps://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-onh]hMhttps://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on}(hjR hhhNhNubah}(h]h ]h"]h$]h&]refurijT uh1j hjJ ubeh}(h]h ]h"]h$]h&]uh1hhhhM0hj9 ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhM0hj ubjP )}(hX**CONSIDER_KSTRTO** The simple_strtol(), simple_strtoll(), simple_strtoul(), and simple_strtoull() functions explicitly ignore overflows, which may lead to unexpected results in callers. The respective kstrtol(), kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the correct replacements. See: https://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoull h](jV )}(h**CONSIDER_KSTRTO**h]j\ )}(hjy h]hCONSIDER_KSTRTO}(hj{ hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjw ubah}(h]h ]h"]h$]h&]uh1jU hhhM9hjs ubjq )}(hhh](h)}(hXThe simple_strtol(), simple_strtoll(), simple_strtoul(), and simple_strtoull() functions explicitly ignore overflows, which may lead to unexpected results in callers. The respective kstrtol(), kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the correct replacements.h]hXThe simple_strtol(), simple_strtoll(), simple_strtoul(), and simple_strtoull() functions explicitly ignore overflows, which may lead to unexpected results in callers. The respective kstrtol(), kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the correct replacements.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM3hj ubh)}(hSee: https://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoullh](hSee: }(hj hhhNhNubj )}(hzhttps://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoullh]hzhttps://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoull}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhM9hj ubeh}(h]h ]h"]h$]h&]uh1jp hjs ubeh}(h]h ]h"]h$]h&]uh1jO hhhM9hj ubjP )}(hX**CONSTANT_CONVERSION** Use of __constant_ form is discouraged for the following functions:: __constant_cpu_to_be[x] __constant_cpu_to_le[x] __constant_be[x]_to_cpu __constant_le[x]_to_cpu __constant_htons __constant_ntohs Using any of these outside of include/uapi/ is not preferred as using the function without __constant_ is identical when the argument is a constant. In big endian systems, the macros like __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to the same expression:: #define __constant_cpu_to_be32(x) ((__force __be32)(__u32)(x)) #define __cpu_to_be32(x) ((__force __be32)(__u32)(x)) In little endian systems, the macros __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to __constant_swab32 and __swab32. __swab32 has a __builtin_constant_p check:: #define __swab32(x) \ (__builtin_constant_p((__u32)(x)) ? \ ___constant_swab32(x) : \ __fswab32(x)) So ultimately they have a special case for constants. Similar is the case with all of the macros in the list. Thus using the __constant_... forms are unnecessarily verbose and not preferred outside of include/uapi. See: https://lore.kernel.org/lkml/1400106425.12666.6.camel@joe-AO725/ h](jV )}(h**CONSTANT_CONVERSION**h]j\ )}(hj h]hCONSTANT_CONVERSION}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhM]hj ubjq )}(hhh](h)}(hIUse of __constant_ form is discouraged for the following functions::h]hHUse of __constant_ form is discouraged for the following functions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM<hj ubj))}(h__constant_cpu_to_be[x] __constant_cpu_to_le[x] __constant_be[x]_to_cpu __constant_le[x]_to_cpu __constant_htons __constant_ntohsh]h__constant_cpu_to_be[x] __constant_cpu_to_le[x] __constant_be[x]_to_cpu __constant_le[x]_to_cpu __constant_htons __constant_ntohs}hj sbah}(h]h ]h"]h$]h&]hhuh1j(hhhM>hj ubh)}(hUsing any of these outside of include/uapi/ is not preferred as using the function without __constant_ is identical when the argument is a constant.h]hUsing any of these outside of include/uapi/ is not preferred as using the function without __constant_ is identical when the argument is a constant.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMEhj ubh)}(hsIn big endian systems, the macros like __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to the same expression::h]hrIn big endian systems, the macros like __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to the same expression:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhj ubj))}(h}#define __constant_cpu_to_be32(x) ((__force __be32)(__u32)(x)) #define __cpu_to_be32(x) ((__force __be32)(__u32)(x))h]h}#define __constant_cpu_to_be32(x) ((__force __be32)(__u32)(x)) #define __cpu_to_be32(x) ((__force __be32)(__u32)(x))}hj sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMLhj ubh)}(hIn little endian systems, the macros __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to __constant_swab32 and __swab32. __swab32 has a __builtin_constant_p check::h]hIn little endian systems, the macros __constant_cpu_to_be32(x) and cpu_to_be32(x) expand to __constant_swab32 and __swab32. __swab32 has a __builtin_constant_p check:}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMOhj ubj))}(h#define __swab32(x) \ (__builtin_constant_p((__u32)(x)) ? \ ___constant_swab32(x) : \ __fswab32(x))h]h#define __swab32(x) \ (__builtin_constant_p((__u32)(x)) ? \ ___constant_swab32(x) : \ __fswab32(x))}hj: sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMShj ubh)}(hSo ultimately they have a special case for constants. Similar is the case with all of the macros in the list. Thus using the __constant_... forms are unnecessarily verbose and not preferred outside of include/uapi.h]hSo ultimately they have a special case for constants. Similar is the case with all of the macros in the list. Thus using the __constant_... forms are unnecessarily verbose and not preferred outside of include/uapi.}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMXhj ubh)}(hESee: https://lore.kernel.org/lkml/1400106425.12666.6.camel@joe-AO725/h](hSee: }(hjV hhhNhNubj )}(h@https://lore.kernel.org/lkml/1400106425.12666.6.camel@joe-AO725/h]h@https://lore.kernel.org/lkml/1400106425.12666.6.camel@joe-AO725/}(hj^ hhhNhNubah}(h]h ]h"]h$]h&]refurij` uh1j hjV ubeh}(h]h ]h"]h$]h&]uh1hhhhM]hj ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhM]hj ubjP )}(hX:**DEPRECATED_API** Usage of a deprecated RCU API is detected. It is recommended to replace old flavourful RCU APIs by their new vanilla-RCU counterparts. The full list of available RCU APIs can be viewed from the kernel docs. See: https://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apis h](jV )}(h**DEPRECATED_API**h]j\ )}(hj h]hDEPRECATED_API}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhMehj ubjq )}(hhh](h)}(hUsage of a deprecated RCU API is detected. It is recommended to replace old flavourful RCU APIs by their new vanilla-RCU counterparts.h]hUsage of a deprecated RCU API is detected. It is recommended to replace old flavourful RCU APIs by their new vanilla-RCU counterparts.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM`hj ubh)}(hGThe full list of available RCU APIs can be viewed from the kernel docs.h]hGThe full list of available RCU APIs can be viewed from the kernel docs.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMchj ubh)}(hTSee: https://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apish](hSee: }(hj hhhNhNubj )}(hOhttps://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apish]hOhttps://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apis}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhMehj ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhMehj ubjP )}(hX **DEVICE_ATTR_FUNCTIONS** The function names used in DEVICE_ATTR is unusual. Typically, the store and show functions are used with _store and _show, where is a named attribute variable of the device. Consider the following examples:: static DEVICE_ATTR(type, 0444, type_show, NULL); static DEVICE_ATTR(power, 0644, power_show, power_store); The function names should preferably follow the above pattern. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes h](jV )}(h**DEVICE_ATTR_FUNCTIONS**h]j\ )}(hj h]hDEVICE_ATTR_FUNCTIONS}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhMshj ubjq )}(hhh](h)}(hThe function names used in DEVICE_ATTR is unusual. Typically, the store and show functions are used with _store and _show, where is a named attribute variable of the device.h]hThe function names used in DEVICE_ATTR is unusual. Typically, the store and show functions are used with _store and _show, where is a named attribute variable of the device.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhhj ubh)}(h!Consider the following examples::h]h Consider the following examples:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMlhj ubj))}(hjstatic DEVICE_ATTR(type, 0444, type_show, NULL); static DEVICE_ATTR(power, 0644, power_show, power_store);h]hjstatic DEVICE_ATTR(type, 0444, type_show, NULL); static DEVICE_ATTR(power, 0644, power_show, power_store);}hj sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMnhj ubh)}(h>The function names should preferably follow the above pattern.h]h>The function names should preferably follow the above pattern.}(hj* hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj ubh)}(hZSee: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh](hSee: }(hj8 hhhNhNubj )}(hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh]hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]refurijB uh1j hj8 ubeh}(h]h ]h"]h$]h&]uh1hhhhMshj ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhMshj ubjP )}(hXJ**DEVICE_ATTR_RO** The DEVICE_ATTR_RO(name) helper macro can be used instead of DEVICE_ATTR(name, 0444, name_show, NULL); Note that the macro automatically appends _show to the named attribute variable of the device for the show method. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes h](jV )}(h**DEVICE_ATTR_RO**h]j\ )}(hjg h]hDEVICE_ATTR_RO}(hji hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hje ubah}(h]h ]h"]h$]h&]uh1jU hhhM|hja ubjq )}(hhh](h)}(hfThe DEVICE_ATTR_RO(name) helper macro can be used instead of DEVICE_ATTR(name, 0444, name_show, NULL);h]hfThe DEVICE_ATTR_RO(name) helper macro can be used instead of DEVICE_ATTR(name, 0444, name_show, NULL);}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMvhj| ubh)}(hrNote that the macro automatically appends _show to the named attribute variable of the device for the show method.h]hrNote that the macro automatically appends _show to the named attribute variable of the device for the show method.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhj| ubh)}(hZSee: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh](hSee: }(hj hhhNhNubj )}(hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh]hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhM|hj| ubeh}(h]h ]h"]h$]h&]uh1jp hja ubeh}(h]h ]h"]h$]h&]uh1jO hhhM|hj ubjP )}(hXf**DEVICE_ATTR_RW** The DEVICE_ATTR_RW(name) helper macro can be used instead of DEVICE_ATTR(name, 0644, name_show, name_store); Note that the macro automatically appends _show and _store to the named attribute variable of the device for the show and store methods. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes h](jV )}(h**DEVICE_ATTR_RW**h]j\ )}(hj h]hDEVICE_ATTR_RW}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj ubah}(h]h ]h"]h$]h&]uh1jU hhhMhj ubjq )}(hhh](h)}(hlThe DEVICE_ATTR_RW(name) helper macro can be used instead of DEVICE_ATTR(name, 0644, name_show, name_store);h]hlThe DEVICE_ATTR_RW(name) helper macro can be used instead of DEVICE_ATTR(name, 0644, name_show, name_store);}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubh)}(hNote that the macro automatically appends _show and _store to the named attribute variable of the device for the show and store methods.h]hNote that the macro automatically appends _show and _store to the named attribute variable of the device for the show and store methods.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubh)}(hZSee: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh](hSee: }(hj hhhNhNubj )}(hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh]hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hj ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hXM**DEVICE_ATTR_WO** The DEVICE_AATR_WO(name) helper macro can be used instead of DEVICE_ATTR(name, 0200, NULL, name_store); Note that the macro automatically appends _store to the named attribute variable of the device for the store method. See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes h](jV )}(h**DEVICE_ATTR_WO**h]j\ )}(hj-h]hDEVICE_ATTR_WO}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj+ubah}(h]h ]h"]h$]h&]uh1jU hhhMhj'ubjq )}(hhh](h)}(hgThe DEVICE_AATR_WO(name) helper macro can be used instead of DEVICE_ATTR(name, 0200, NULL, name_store);h]hgThe DEVICE_AATR_WO(name) helper macro can be used instead of DEVICE_ATTR(name, 0200, NULL, name_store);}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjBubh)}(htNote that the macro automatically appends _store to the named attribute variable of the device for the store method.h]htNote that the macro automatically appends _store to the named attribute variable of the device for the store method.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjBubh)}(hZSee: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh](hSee: }(hjahhhNhNubj )}(hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributesh]hUhttps://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes}(hjihhhNhNubah}(h]h ]h"]h$]h&]refurijkuh1j hjaubeh}(h]h ]h"]h$]h&]uh1hhhhMhjBubeh}(h]h ]h"]h$]h&]uh1jp hj'ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hXH**DUPLICATED_SYSCTL_CONST** Commit d91bff3011cf ("proc/sysctl: add shared variables for range check") added some shared const variables to be used instead of a local copy in each source file. Consider replacing the sysctl range checking value with the shared one in include/linux/sysctl.h. The following conversion scheme may be used:: &zero -> SYSCTL_ZERO &one -> SYSCTL_ONE &int_max -> SYSCTL_INT_MAX See: 1. https://lore.kernel.org/lkml/20190430180111.10688-1-mcroce@redhat.com/ 2. https://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/ h](jV )}(h**DUPLICATED_SYSCTL_CONST**h]j\ )}(hjh]hDUPLICATED_SYSCTL_CONST}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(hCommit d91bff3011cf ("proc/sysctl: add shared variables for range check") added some shared const variables to be used instead of a local copy in each source file.h]hCommit d91bff3011cf (“proc/sysctl: add shared variables for range check”) added some shared const variables to be used instead of a local copy in each source file.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hConsider replacing the sysctl range checking value with the shared one in include/linux/sysctl.h. The following conversion scheme may be used::h]hConsider replacing the sysctl range checking value with the shared one in include/linux/sysctl.h. The following conversion scheme may be used:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj))}(hO&zero -> SYSCTL_ZERO &one -> SYSCTL_ONE &int_max -> SYSCTL_INT_MAXh]hO&zero -> SYSCTL_ZERO &one -> SYSCTL_ONE &int_max -> SYSCTL_INT_MAX}hjsbah}(h]h ]h"]h$]h&]hhuh1j(hhhMhjubh)}(hSee:h]hSee:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubjG)}(h1. https://lore.kernel.org/lkml/20190430180111.10688-1-mcroce@redhat.com/ 2. https://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/ h]henumerated_list)}(hhh](jR)}(hFhttps://lore.kernel.org/lkml/20190430180111.10688-1-mcroce@redhat.com/h]h)}(hjh]j )}(hjh]hFhttps://lore.kernel.org/lkml/20190430180111.10688-1-mcroce@redhat.com/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jQhjubjR)}(hGhttps://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/ h]h)}(hFhttps://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/h]j )}(hjh]hFhttps://lore.kernel.org/lkml/20190531131422.14970-1-mcroce@redhat.com/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jQhjubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjubah}(h]h ]h"]h$]h&]uh1jFhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hX5**ENOSYS** ENOSYS means that a nonexistent system call was called. Earlier, it was wrongly used for things like invalid operations on otherwise valid syscalls. This should be avoided in new code. See: https://lore.kernel.org/lkml/5eb299021dec23c1a48fa7d9f2c8b794e967766d.1408730669.git.luto@amacapital.net/ h](jV )}(h **ENOSYS**h]j\ )}(hjOh]hENOSYS}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjMubah}(h]h ]h"]h$]h&]uh1jU hhhMhjIubjq )}(hhh](h)}(hENOSYS means that a nonexistent system call was called. Earlier, it was wrongly used for things like invalid operations on otherwise valid syscalls. This should be avoided in new code.h]hENOSYS means that a nonexistent system call was called. Earlier, it was wrongly used for things like invalid operations on otherwise valid syscalls. This should be avoided in new code.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjdubh)}(hnSee: https://lore.kernel.org/lkml/5eb299021dec23c1a48fa7d9f2c8b794e967766d.1408730669.git.luto@amacapital.net/h](hSee: }(hjuhhhNhNubj )}(hihttps://lore.kernel.org/lkml/5eb299021dec23c1a48fa7d9f2c8b794e967766d.1408730669.git.luto@amacapital.net/h]hihttps://lore.kernel.org/lkml/5eb299021dec23c1a48fa7d9f2c8b794e967766d.1408730669.git.luto@amacapital.net/}(hj}hhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjuubeh}(h]h ]h"]h$]h&]uh1hhhhMhjdubeh}(h]h ]h"]h$]h&]uh1jp hjIubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**ENOTSUPP** ENOTSUPP is not a standard error code and should be avoided in new patches. EOPNOTSUPP should be used instead. See: https://lore.kernel.org/netdev/20200510182252.GA411829@lunn.ch/ h](jV )}(h **ENOTSUPP**h]j\ )}(hjh]hENOTSUPP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(hnENOTSUPP is not a standard error code and should be avoided in new patches. EOPNOTSUPP should be used instead.h]hnENOTSUPP is not a standard error code and should be avoided in new patches. EOPNOTSUPP should be used instead.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hDSee: https://lore.kernel.org/netdev/20200510182252.GA411829@lunn.ch/h](hSee: }(hjhhhNhNubj )}(h?https://lore.kernel.org/netdev/20200510182252.GA411829@lunn.ch/h]h?https://lore.kernel.org/netdev/20200510182252.GA411829@lunn.ch/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hU**EXPORT_SYMBOL** EXPORT_SYMBOL should immediately follow the symbol to be exported. h](jV )}(h**EXPORT_SYMBOL**h]j\ )}(hjh]h EXPORT_SYMBOL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh]h)}(hBEXPORT_SYMBOL should immediately follow the symbol to be exported.h]hBEXPORT_SYMBOL should immediately follow the symbol to be exported.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hX|**IN_ATOMIC** in_atomic() is not for driver use so any such use is reported as an ERROR. Also in_atomic() is often used to determine if sleeping is permitted, but it is not reliable in this use model. Therefore its use is strongly discouraged. However, in_atomic() is ok for core kernel use. See: https://lore.kernel.org/lkml/20080320201723.b87b3732.akpm@linux-foundation.org/ h](jV )}(h **IN_ATOMIC**h]j\ )}(hj1h]h IN_ATOMIC}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hj/ubah}(h]h ]h"]h$]h&]uh1jU hhhMhj+ubjq )}(hhh](h)}(hin_atomic() is not for driver use so any such use is reported as an ERROR. Also in_atomic() is often used to determine if sleeping is permitted, but it is not reliable in this use model. Therefore its use is strongly discouraged.h]hin_atomic() is not for driver use so any such use is reported as an ERROR. Also in_atomic() is often used to determine if sleeping is permitted, but it is not reliable in this use model. Therefore its use is strongly discouraged.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjFubh)}(h/However, in_atomic() is ok for core kernel use.h]h/However, in_atomic() is ok for core kernel use.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjFubh)}(hTSee: https://lore.kernel.org/lkml/20080320201723.b87b3732.akpm@linux-foundation.org/h](hSee: }(hjehhhNhNubj )}(hOhttps://lore.kernel.org/lkml/20080320201723.b87b3732.akpm@linux-foundation.org/h]hOhttps://lore.kernel.org/lkml/20080320201723.b87b3732.akpm@linux-foundation.org/}(hjmhhhNhNubah}(h]h ]h"]h$]h&]refurijouh1j hjeubeh}(h]h ]h"]h$]h&]uh1hhhhMhjFubeh}(h]h ]h"]h$]h&]uh1jp hj+ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hX**LOCKDEP** The lockdep_no_validate class was added as a temporary measure to prevent warnings on conversion of device->sem to device->mutex. It should not be used for any other purpose. See: https://lore.kernel.org/lkml/1268959062.9440.467.camel@laptop/ h](jV )}(h **LOCKDEP**h]j\ )}(hjh]hLOCKDEP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(hThe lockdep_no_validate class was added as a temporary measure to prevent warnings on conversion of device->sem to device->mutex. It should not be used for any other purpose.h]hThe lockdep_no_validate class was added as a temporary measure to prevent warnings on conversion of device->sem to device->mutex. It should not be used for any other purpose.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hCSee: https://lore.kernel.org/lkml/1268959062.9440.467.camel@laptop/h](hSee: }(hjhhhNhNubj )}(h>https://lore.kernel.org/lkml/1268959062.9440.467.camel@laptop/h]h>https://lore.kernel.org/lkml/1268959062.9440.467.camel@laptop/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**MALFORMED_INCLUDE** The #include statement has a malformed path. This has happened because the author has included a double slash "//" in the pathname accidentally. h](jV )}(h**MALFORMED_INCLUDE**h]j\ )}(hjh]hMALFORMED_INCLUDE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh]h)}(hThe #include statement has a malformed path. This has happened because the author has included a double slash "//" in the pathname accidentally.h]hThe #include statement has a malformed path. This has happened because the author has included a double slash “//” in the pathname accidentally.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**USE_LOCKDEP** lockdep_assert_held() annotations should be preferred over assertions based on spin_is_locked() See: https://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotations h](jV )}(h**USE_LOCKDEP**h]j\ )}(hj!h]h USE_LOCKDEP}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(h_lockdep_assert_held() annotations should be preferred over assertions based on spin_is_locked()h]h_lockdep_assert_held() annotations should be preferred over assertions based on spin_is_locked()}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj6ubh)}(hSSee: https://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotationsh](hSee: }(hjGhhhNhNubj )}(hNhttps://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotationsh]hNhttps://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotations}(hjOhhhNhNubah}(h]h ]h"]h$]h&]refurijQuh1j hjGubeh}(h]h ]h"]h$]h&]uh1hhhhMhj6ubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hQ**UAPI_INCLUDE** No #include statements in include/uapi should use a uapi/ path. h](jV )}(h**UAPI_INCLUDE**h]j\ )}(hjvh]h UAPI_INCLUDE}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjtubah}(h]h ]h"]h$]h&]uh1jU hhhMhjpubjq )}(hhh]h)}(h?No #include statements in include/uapi should use a uapi/ path.h]h?No #include statements in include/uapi should use a uapi/ path.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jp hjpubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**USLEEP_RANGE** usleep_range() should be preferred over udelay(). The proper way of using usleep_range() is mentioned in the kernel docs. h](jV )}(h**USLEEP_RANGE**h]j\ )}(hjh]h USLEEP_RANGE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh]h)}(hyusleep_range() should be preferred over udelay(). The proper way of using usleep_range() is mentioned in the kernel docs.h]hyusleep_range() should be preferred over udelay(). The proper way of using usleep_range() is mentioned in the kernel docs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubeh}(h]h ]h"]h$]h&]uh1jJ hj ubah}(h]h ]h"]h$]h&]uh1jFhhhM!hj hhubeh}(h] api-usageah ]h"] api usageah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hCommentsh]hComments}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubjG)}(hX.**BLOCK_COMMENT_STYLE** The comment style is incorrect. The preferred style for multi- line comments is:: /* * This is the preferred style * for multi line comments. */ See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting **C99_COMMENTS** C99 style single line comments (//) should not be used. Prefer the block comment style instead. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting **DATA_RACE** Applications of data_race() should have a comment so as to document the reasoning behind why it was deemed safe. See: https://lore.kernel.org/lkml/20200401101714.44781-1-elver@google.com/ **FSF_MAILING_ADDRESS** Kernel maintainers reject new instances of the GPL boilerplate paragraph directing people to write to the FSF for a copy of the GPL, since the FSF has moved in the past and may do so again. So do not write paragraphs about writing to the Free Software Foundation's mailing address. See: https://lore.kernel.org/lkml/20131006222342.GT19510@leaf/ **UNCOMMENTED_RGMII_MODE** Historically, the RGMII PHY modes specified in Device Trees have been used inconsistently, often referring to the usage of delays on the PHY side rather than describing the board. PHY modes "rgmii", "rgmii-rxid" and "rgmii-txid" modes require the clock signal to be delayed on the PCB; this unusual configuration should be described in a comment. If they are not (meaning that the delay is realized internally in the MAC or PHY), "rgmii-id" is the correct PHY mode. h]jK )}(hhh](jP )}(hX**BLOCK_COMMENT_STYLE** The comment style is incorrect. The preferred style for multi- line comments is:: /* * This is the preferred style * for multi line comments. */ See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting h](jV )}(h**BLOCK_COMMENT_STYLE**h]j\ )}(hjh]hBLOCK_COMMENT_STYLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhj ubjq )}(hhh](h)}(hRThe comment style is incorrect. The preferred style for multi- line comments is::h]hQThe comment style is incorrect. The preferred style for multi- line comments is:}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubj))}(hA/* * This is the preferred style * for multi line comments. */h]hA/* * This is the preferred style * for multi line comments. */}hj8sbah}(h]h ]h"]h$]h&]hhuh1j(hhhMhj'ubh)}(hPSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#commentingh](hSee: }(hjFhhhNhNubj )}(hKhttps://www.kernel.org/doc/html/latest/process/coding-style.html#commentingh]hKhttps://www.kernel.org/doc/html/latest/process/coding-style.html#commenting}(hjNhhhNhNubah}(h]h ]h"]h$]h&]refurijPuh1j hjFubeh}(h]h ]h"]h$]h&]uh1hhhhMhj'ubeh}(h]h ]h"]h$]h&]uh1jp hj ubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**C99_COMMENTS** C99 style single line comments (//) should not be used. Prefer the block comment style instead. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting h](jV )}(h**C99_COMMENTS**h]j\ )}(hjuh]h C99_COMMENTS}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjsubah}(h]h ]h"]h$]h&]uh1jU hhhMhjoubjq )}(hhh](h)}(h_C99 style single line comments (//) should not be used. Prefer the block comment style instead.h]h_C99 style single line comments (//) should not be used. Prefer the block comment style instead.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hPSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#commentingh](hSee: }(hjhhhNhNubj )}(hKhttps://www.kernel.org/doc/html/latest/process/coding-style.html#commentingh]hKhttps://www.kernel.org/doc/html/latest/process/coding-style.html#commenting}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjoubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(h**DATA_RACE** Applications of data_race() should have a comment so as to document the reasoning behind why it was deemed safe. See: https://lore.kernel.org/lkml/20200401101714.44781-1-elver@google.com/ h](jV )}(h **DATA_RACE**h]j\ )}(hjh]h DATA_RACE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(hpApplications of data_race() should have a comment so as to document the reasoning behind why it was deemed safe.h]hpApplications of data_race() should have a comment so as to document the reasoning behind why it was deemed safe.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hJSee: https://lore.kernel.org/lkml/20200401101714.44781-1-elver@google.com/h](hSee: }(hjhhhNhNubj )}(hEhttps://lore.kernel.org/lkml/20200401101714.44781-1-elver@google.com/h]hEhttps://lore.kernel.org/lkml/20200401101714.44781-1-elver@google.com/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hXr**FSF_MAILING_ADDRESS** Kernel maintainers reject new instances of the GPL boilerplate paragraph directing people to write to the FSF for a copy of the GPL, since the FSF has moved in the past and may do so again. So do not write paragraphs about writing to the Free Software Foundation's mailing address. See: https://lore.kernel.org/lkml/20131006222342.GT19510@leaf/ h](jV )}(h**FSF_MAILING_ADDRESS**h]j\ )}(hjh]hFSF_MAILING_ADDRESS}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjubah}(h]h ]h"]h$]h&]uh1jU hhhMhjubjq )}(hhh](h)}(hXKernel maintainers reject new instances of the GPL boilerplate paragraph directing people to write to the FSF for a copy of the GPL, since the FSF has moved in the past and may do so again. So do not write paragraphs about writing to the Free Software Foundation's mailing address.h]hXKernel maintainers reject new instances of the GPL boilerplate paragraph directing people to write to the FSF for a copy of the GPL, since the FSF has moved in the past and may do so again. So do not write paragraphs about writing to the Free Software Foundation’s mailing address.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj4ubh)}(h>See: https://lore.kernel.org/lkml/20131006222342.GT19510@leaf/h](hSee: }(hjEhhhNhNubj )}(h9https://lore.kernel.org/lkml/20131006222342.GT19510@leaf/h]h9https://lore.kernel.org/lkml/20131006222342.GT19510@leaf/}(hjMhhhNhNubah}(h]h ]h"]h$]h&]refurijOuh1j hjEubeh}(h]h ]h"]h$]h&]uh1hhhhMhj4ubeh}(h]h ]h"]h$]h&]uh1jp hjubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubjP )}(hX**UNCOMMENTED_RGMII_MODE** Historically, the RGMII PHY modes specified in Device Trees have been used inconsistently, often referring to the usage of delays on the PHY side rather than describing the board. PHY modes "rgmii", "rgmii-rxid" and "rgmii-txid" modes require the clock signal to be delayed on the PCB; this unusual configuration should be described in a comment. If they are not (meaning that the delay is realized internally in the MAC or PHY), "rgmii-id" is the correct PHY mode. h](jV )}(h**UNCOMMENTED_RGMII_MODE**h]j\ )}(hjth]hUNCOMMENTED_RGMII_MODE}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1j[ hjrubah}(h]h ]h"]h$]h&]uh1jU hhhMhjnubjq )}(hhh](h)}(hHistorically, the RGMII PHY modes specified in Device Trees have been used inconsistently, often referring to the usage of delays on the PHY side rather than describing the board.h]hHistorically, the RGMII PHY modes specified in Device Trees have been used inconsistently, often referring to the usage of delays on the PHY side rather than describing the board.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hXPHY modes "rgmii", "rgmii-rxid" and "rgmii-txid" modes require the clock signal to be delayed on the PCB; this unusual configuration should be described in a comment. If they are not (meaning that the delay is realized internally in the MAC or PHY), "rgmii-id" is the correct PHY mode.h]hX-PHY modes “rgmii”, “rgmii-rxid” and “rgmii-txid” modes require the clock signal to be delayed on the PCB; this unusual configuration should be described in a comment. If they are not (meaning that the delay is realized internally in the MAC or PHY), “rgmii-id” is the correct PHY mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jp hjnubeh}(h]h ]h"]h$]h&]uh1jO hhhMhj ubeh}(h]h ]h"]h$]h&]uh1jJ hjubah}(h]h ]h"]h$]h&]uh1jFhhhMhjhhubeh}(h]commentsah ]h"]commentsah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hCommit messageh]hCommit message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubjG)}(hXn**BAD_SIGN_OFF** The signed-off-by line does not fall in line with the standards specified by the community. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1 **BAD_STABLE_ADDRESS_STYLE** The email format for stable is incorrect. Some valid options for stable address are:: 1. stable@vger.kernel.org 2. stable@kernel.org For adding version info, the following comment style should be used:: stable@vger.kernel.org # version info **COMMIT_COMMENT_SYMBOL** Commit log lines starting with a '#' are ignored by git as comments. To solve this problem addition of a single space infront of the log line is enough. **COMMIT_MESSAGE** The patch is missing a commit description. A brief description of the changes made by the patch should be added. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes **EMAIL_SUBJECT** Naming the tool that found the issue is not very useful in the subject line. A good subject line summarizes the change that the patch brings. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes **FROM_SIGN_OFF_MISMATCH** The author's email does not match with that in the Signed-off-by: line(s). This can be sometimes caused due to an improperly configured email client. This message is emitted due to any of the following reasons:: - The email names do not match. - The email addresses do not match. - The email subaddresses do not match. - The email comments do not match. **MISSING_SIGN_OFF** The patch is missing a Signed-off-by line. A signed-off-by line should be added according to Developer's certificate of Origin. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin **NO_AUTHOR_SIGN_OFF** The author of the patch has not signed off the patch. It is required that a simple sign off line should be present at the end of explanation of the patch to denote that the author has written it or otherwise has the rights to pass it on as an open source patch. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin **DIFF_IN_COMMIT_MSG** Avoid having diff content in commit message. This causes problems when one tries to apply a file containing both the changelog and the diff because patch(1) tries to apply the diff which it found in the changelog. See: https://lore.kernel.org/lkml/20150611134006.9df79a893e3636019ad2759e@linux-foundation.org/ **GERRIT_CHANGE_ID** To be picked up by gerrit, the footer of the commit message might have a Change-Id like:: Change-Id: Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fbf5b Signed-off-by: A. U. Thor The Change-Id line must be removed before submitting. **GIT_COMMIT_ID** The proper way to reference a commit id is: commit <12+ chars of sha1> ("") An example may be:: Commit e21d2170f36602ae2708 ("video: remove unnecessary platform_set_drvdata()") removed the unnecessary platform_set_drvdata(), but left the variable "dev" unused, delete it. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes **BAD_FIXES_TAG** The Fixes: tag is malformed or does not follow the community conventions. This can occur if the tag have been split into multiple lines (e.g., when pasted in an email program with word wrapping enabled). See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes **BAD_COMMIT_SEPARATOR** The commit separator is a single line with 3 dashes. The regex match is '^---$' Lines that start with 3 dashes and have more content on the same line may confuse tools that apply patches. h]jK ��)}(hhh](jP ��)}(h**BAD_SIGN_OFF** The signed-off-by line does not fall in line with the standards specified by the community. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1 h](jV ��)}(h**BAD_SIGN_OFF**h]j\ ��)}(hj��h]h BAD_SIGN_OFF}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hj��ubjq ��)}(hhh](h)}(h[The signed-off-by line does not fall in line with the standards specified by the community.h]h[The signed-off-by line does not fall in line with the standards specified by the community.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(hqSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1h](hSee: }(hj ��hhhNhNubj ��)}(hlhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1h]hlhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj ��ubeh}(h]h ]h"]h$]h&]uh1hhhhM hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj��ubjP ��)}(hX��**BAD_STABLE_ADDRESS_STYLE** The email format for stable is incorrect. Some valid options for stable address are:: 1. stable@vger.kernel.org 2. stable@kernel.org For adding version info, the following comment style should be used:: stable@vger.kernel.org # version info h](jV ��)}(h**BAD_STABLE_ADDRESS_STYLE**h]j\ ��)}(hj;��h]hBAD_STABLE_ADDRESS_STYLE}(hj=��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj9��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj5��ubjq ��)}(hhh](h)}(hUThe email format for stable is incorrect. Some valid options for stable address are::h]hTThe email format for stable is incorrect. Some valid options for stable address are:}(hjS��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjP��ubj)��)}(h.1. stable@vger.kernel.org 2. stable@kernel.orgh]h.1. stable@vger.kernel.org 2. stable@kernel.org}hja��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjP��ubh)}(hEFor adding version info, the following comment style should be used::h]hDFor adding version info, the following comment style should be used:}(hjo��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjP��ubj)��)}(h%stable@vger.kernel.org # version infoh]h%stable@vger.kernel.org # version info}hj}��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjP��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj5��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(h**COMMIT_COMMENT_SYMBOL** Commit log lines starting with a '#' are ignored by git as comments. To solve this problem addition of a single space infront of the log line is enough. h](jV ��)}(h**COMMIT_COMMENT_SYMBOL**h]j\ ��)}(hj��h]hCOMMIT_COMMENT_SYMBOL}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh]h)}(hCommit log lines starting with a '#' are ignored by git as comments. To solve this problem addition of a single space infront of the log line is enough.h]hCommit log lines starting with a ‘#’ are ignored by git as comments. To solve this problem addition of a single space infront of the log line is enough.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubah}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(h**COMMIT_MESSAGE** The patch is missing a commit description. A brief description of the changes made by the patch should be added. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes h](jV ��)}(h**COMMIT_MESSAGE**h]j\ ��)}(hj��h]hCOMMIT_MESSAGE}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hj��ubjq ��)}(hhh](h)}(hqThe patch is missing a commit description. A brief description of the changes made by the patch should be added.h]hqThe patch is missing a commit description. A brief description of the changes made by the patch should be added.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(haSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh](hSee: }(hj��hhhNhNubj ��)}(h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh]h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhM hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj��ubjP ��)}(hX��**EMAIL_SUBJECT** Naming the tool that found the issue is not very useful in the subject line. A good subject line summarizes the change that the patch brings. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes h](jV ��)}(h**EMAIL_SUBJECT**h]j\ ��)}(hj*��h]h EMAIL_SUBJECT}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj(��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM'hj$��ubjq ��)}(hhh](h)}(hNaming the tool that found the issue is not very useful in the subject line. A good subject line summarizes the change that the patch brings.h]hNaming the tool that found the issue is not very useful in the subject line. A good subject line summarizes the change that the patch brings.}(hjB��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hj?��ubh)}(haSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh](hSee: }(hjP��hhhNhNubj ��)}(h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh]h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes}(hjX��hhhNhNubah}(h]h ]h"]h$]h&]refurijZ��uh1j ��hjP��ubeh}(h]h ]h"]h$]h&]uh1hhhhM'hj?��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj$��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM'hj��ubjP ��)}(hX��**FROM_SIGN_OFF_MISMATCH** The author's email does not match with that in the Signed-off-by: line(s). This can be sometimes caused due to an improperly configured email client. This message is emitted due to any of the following reasons:: - The email names do not match. - The email addresses do not match. - The email subaddresses do not match. - The email comments do not match. h](jV ��)}(h**FROM_SIGN_OFF_MISMATCH**h]j\ ��)}(hj��h]hFROM_SIGN_OFF_MISMATCH}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj}��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM3hjy��ubjq ��)}(hhh](h)}(hThe author's email does not match with that in the Signed-off-by: line(s). This can be sometimes caused due to an improperly configured email client.h]hThe author’s email does not match with that in the Signed-off-by: line(s). This can be sometimes caused due to an improperly configured email client.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM*hj��ubh)}(h=This message is emitted due to any of the following reasons::h]h<This message is emitted due to any of the following reasons:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM.hj��ubj)��)}(h- The email names do not match. - The email addresses do not match. - The email subaddresses do not match. - The email comments do not match.h]h- The email names do not match. - The email addresses do not match. - The email subaddresses do not match. - The email comments do not match.}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM0hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjy��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM3hj��ubjP ��)}(hX��**MISSING_SIGN_OFF** The patch is missing a Signed-off-by line. A signed-off-by line should be added according to Developer's certificate of Origin. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin h](jV ��)}(h**MISSING_SIGN_OFF**h]j\ ��)}(hj��h]hMISSING_SIGN_OFF}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM:hj��ubjq ��)}(hhh](h)}(hThe patch is missing a Signed-off-by line. A signed-off-by line should be added according to Developer's certificate of Origin.h]hThe patch is missing a Signed-off-by line. A signed-off-by line should be added according to Developer’s certificate of Origin.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM6hj��ubh)}(hSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-originh](hSee: }(hj��hhhNhNubj ��)}(h{https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-originh]h{https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhM:hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM:hj��ubjP ��)}(hX��**NO_AUTHOR_SIGN_OFF** The author of the patch has not signed off the patch. It is required that a simple sign off line should be present at the end of explanation of the patch to denote that the author has written it or otherwise has the rights to pass it on as an open source patch. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin h](jV ��)}(h**NO_AUTHOR_SIGN_OFF**h]j\ ��)}(hj(��h]hNO_AUTHOR_SIGN_OFF}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj&��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMChj"��ubjq ��)}(hhh](h)}(hX��The author of the patch has not signed off the patch. It is required that a simple sign off line should be present at the end of explanation of the patch to denote that the author has written it or otherwise has the rights to pass it on as an open source patch.h]hX��The author of the patch has not signed off the patch. It is required that a simple sign off line should be present at the end of explanation of the patch to denote that the author has written it or otherwise has the rights to pass it on as an open source patch.}(hj@��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM=hj=��ubh)}(hSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-originh](hSee: }(hjN��hhhNhNubj ��)}(h{https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-originh]h{https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin}(hjV��hhhNhNubah}(h]h ]h"]h$]h&]refurijX��uh1j ��hjN��ubeh}(h]h ]h"]h$]h&]uh1hhhhMChj=��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj"��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMChj��ubjP ��)}(hXN��**DIFF_IN_COMMIT_MSG** Avoid having diff content in commit message. This causes problems when one tries to apply a file containing both the changelog and the diff because patch(1) tries to apply the diff which it found in the changelog. See: https://lore.kernel.org/lkml/20150611134006.9df79a893e3636019ad2759e@linux-foundation.org/ h](jV ��)}(h**DIFF_IN_COMMIT_MSG**h]j\ ��)}(hj}��h]hDIFF_IN_COMMIT_MSG}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj{��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMKhjw��ubjq ��)}(hhh](h)}(hAvoid having diff content in commit message. This causes problems when one tries to apply a file containing both the changelog and the diff because patch(1) tries to apply the diff which it found in the changelog.h]hAvoid having diff content in commit message. This causes problems when one tries to apply a file containing both the changelog and the diff because patch(1) tries to apply the diff which it found in the changelog.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhj��ubh)}(h_See: https://lore.kernel.org/lkml/20150611134006.9df79a893e3636019ad2759e@linux-foundation.org/h](hSee: }(hj��hhhNhNubj ��)}(hZhttps://lore.kernel.org/lkml/20150611134006.9df79a893e3636019ad2759e@linux-foundation.org/h]hZhttps://lore.kernel.org/lkml/20150611134006.9df79a893e3636019ad2759e@linux-foundation.org/}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMKhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjw��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMKhj��ubjP ��)}(hX��**GERRIT_CHANGE_ID** To be picked up by gerrit, the footer of the commit message might have a Change-Id like:: Change-Id: Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fbf5b Signed-off-by: A. U. Thor <author@example.com> The Change-Id line must be removed before submitting. h](jV ��)}(h**GERRIT_CHANGE_ID**h]j\ ��)}(hj��h]hGERRIT_CHANGE_ID}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMThj��ubjq ��)}(hhh](h)}(hYTo be picked up by gerrit, the footer of the commit message might have a Change-Id like::h]hXTo be picked up by gerrit, the footer of the commit message might have a Change-Id like:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMNhj��ubj)��)}(hcChange-Id: Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fbf5b Signed-off-by: A. U. Thor <author@example.com>h]hcChange-Id: Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fbf5b Signed-off-by: A. U. Thor <author@example.com>}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMQhj��ubh)}(h5The Change-Id line must be removed before submitting.h]h5The Change-Id line must be removed before submitting.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMThj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMThj��ubjP ��)}(hX��**GIT_COMMIT_ID** The proper way to reference a commit id is: commit <12+ chars of sha1> ("<title line>") An example may be:: Commit e21d2170f36602ae2708 ("video: remove unnecessary platform_set_drvdata()") removed the unnecessary platform_set_drvdata(), but left the variable "dev" unused, delete it. See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes h](jV ��)}(h**GIT_COMMIT_ID**h]j\ ��)}(hj&��h]h GIT_COMMIT_ID}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj$��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMahj ��ubjq ��)}(hhh](h)}(hWThe proper way to reference a commit id is: commit <12+ chars of sha1> ("<title line>")h]h[The proper way to reference a commit id is: commit <12+ chars of sha1> (“<title line>”)}(hj>��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMWhj;��ubh)}(hAn example may be::h]hAn example may be:}(hjL��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMZhj;��ubj)��)}(hCommit e21d2170f36602ae2708 ("video: remove unnecessary platform_set_drvdata()") removed the unnecessary platform_set_drvdata(), but left the variable "dev" unused, delete it.h]hCommit e21d2170f36602ae2708 ("video: remove unnecessary platform_set_drvdata()") removed the unnecessary platform_set_drvdata(), but left the variable "dev" unused, delete it.}hjZ��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM\hj;��ubh)}(haSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh](hSee: }(hjh��hhhNhNubj ��)}(h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh]h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes}(hjp��hhhNhNubah}(h]h ]h"]h$]h&]refurijr��uh1j ��hjh��ubeh}(h]h ]h"]h$]h&]uh1hhhhMahj;��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj ��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMahj��ubjP ��)}(hXA��**BAD_FIXES_TAG** The Fixes: tag is malformed or does not follow the community conventions. This can occur if the tag have been split into multiple lines (e.g., when pasted in an email program with word wrapping enabled). See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes h](jV ��)}(h**BAD_FIXES_TAG**h]j\ ��)}(hj��h]h BAD_FIXES_TAG}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhhj��ubjq ��)}(hhh](h)}(hThe Fixes: tag is malformed or does not follow the community conventions. This can occur if the tag have been split into multiple lines (e.g., when pasted in an email program with word wrapping enabled).h]hThe Fixes: tag is malformed or does not follow the community conventions. This can occur if the tag have been split into multiple lines (e.g., when pasted in an email program with word wrapping enabled).}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMdhj��ubh)}(haSee: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh](hSee: }(hj��hhhNhNubj ��)}(h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changesh]h\https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhhj��ubjP ��)}(h**BAD_COMMIT_SEPARATOR** The commit separator is a single line with 3 dashes. The regex match is '^---$' Lines that start with 3 dashes and have more content on the same line may confuse tools that apply patches. h](jV ��)}(h**BAD_COMMIT_SEPARATOR**h]j\ ��)}(hj��h]hBAD_COMMIT_SEPARATOR}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMnhj��ubjq ��)}(hhh]h)}(hThe commit separator is a single line with 3 dashes. The regex match is '^---$' Lines that start with 3 dashes and have more content on the same line may confuse tools that apply patches.h]hThe commit separator is a single line with 3 dashes. The regex match is ‘^---$’ Lines that start with 3 dashes and have more content on the same line may confuse tools that apply patches.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMkhj��ubah}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMnhj��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhj��hhubeh}(h]commit-messageah ]h"]commit messageah$]h&]uh1hhj��hhhhhMubh)}(hhh](h)}(hComparison styleh]hComparison style}(hj5��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2��hhhhhMqubjG��)}(hXZ��**ASSIGN_IN_IF** Do not use assignments in if condition. Example:: if ((foo = bar(...)) < BAZ) { should be written as:: foo = bar(...); if (foo < BAZ) { **BOOL_COMPARISON** Comparisons of A to true and false are better written as A and !A. See: https://lore.kernel.org/lkml/1365563834.27174.12.camel@joe-AO722/ **COMPARISON_TO_NULL** Comparisons to NULL in the form (foo == NULL) or (foo != NULL) are better written as (!foo) and (foo). **CONSTANT_COMPARISON** Comparisons with a constant or upper case identifier on the left side of the test should be avoided. h]jK ��)}(hhh](jP ��)}(h**ASSIGN_IN_IF** Do not use assignments in if condition. Example:: if ((foo = bar(...)) < BAZ) { should be written as:: foo = bar(...); if (foo < BAZ) { h](jV ��)}(h**ASSIGN_IN_IF**h]j\ ��)}(hjP��h]h ASSIGN_IN_IF}(hjR��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjN��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM|hjJ��ubjq ��)}(hhh](h)}(h1Do not use assignments in if condition. Example::h]h0Do not use assignments in if condition. Example:}(hjh��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMthje��ubj)��)}(hif ((foo = bar(...)) < BAZ) {h]hif ((foo = bar(...)) < BAZ) {}hjv��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMwhje��ubh)}(hshould be written as::h]hshould be written as:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhje��ubj)��)}(h foo = bar(...); if (foo < BAZ) {h]h foo = bar(...); if (foo < BAZ) {}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM{hje��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjJ��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM|hjG��ubjP ��)}(h**BOOL_COMPARISON** Comparisons of A to true and false are better written as A and !A. See: https://lore.kernel.org/lkml/1365563834.27174.12.camel@joe-AO722/ h](jV ��)}(h**BOOL_COMPARISON**h]j\ ��)}(hj��h]hBOOL_COMPARISON}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hBComparisons of A to true and false are better written as A and !A.h]hBComparisons of A to true and false are better written as A and !A.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(hFSee: https://lore.kernel.org/lkml/1365563834.27174.12.camel@joe-AO722/h](hSee: }(hj��hhhNhNubj ��)}(hAhttps://lore.kernel.org/lkml/1365563834.27174.12.camel@joe-AO722/h]hAhttps://lore.kernel.org/lkml/1365563834.27174.12.camel@joe-AO722/}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhjG��ubjP ��)}(h~**COMPARISON_TO_NULL** Comparisons to NULL in the form (foo == NULL) or (foo != NULL) are better written as (!foo) and (foo). h](jV ��)}(h**COMPARISON_TO_NULL**h]j\ ��)}(hj��h]hCOMPARISON_TO_NULL}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh]h)}(hfComparisons to NULL in the form (foo == NULL) or (foo != NULL) are better written as (!foo) and (foo).h]hfComparisons to NULL in the form (foo == NULL) or (foo != NULL) are better written as (!foo) and (foo).}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubah}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhjG��ubjP ��)}(h~**CONSTANT_COMPARISON** Comparisons with a constant or upper case identifier on the left side of the test should be avoided. h](jV ��)}(h**CONSTANT_COMPARISON**h]j\ ��)}(hj?��h]hCONSTANT_COMPARISON}(hjA��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj=��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj9��ubjq ��)}(hhh]h)}(hdComparisons with a constant or upper case identifier on the left side of the test should be avoided.h]hdComparisons with a constant or upper case identifier on the left side of the test should be avoided.}(hjW��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjT��ubah}(h]h ]h"]h$]h&]uh1jp ��hj9��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhjG��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hjC��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMshj2��hhubeh}(h]comparison-styleah ]h"]comparison styleah$]h&]uh1hhj��hhhhhMqubh)}(hhh](h)}(hIndentation and Line Breaksh]hIndentation and Line Breaks}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj��hhhhhMubjG��)}(hX@��**CODE_INDENT** Code indent should use tabs instead of spaces. Outside of comments, documentation and Kconfig, spaces are never used for indentation. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation **DEEP_INDENTATION** Indentation with 6 or more tabs usually indicate overly indented code. It is suggested to refactor excessive indentation of if/else/for/do/while/switch statements. See: https://lore.kernel.org/lkml/1328311239.21255.24.camel@joe2Laptop/ **SWITCH_CASE_INDENT_LEVEL** switch should be at the same indent as case. Example:: switch (suffix) { case 'G': case 'g': mem <<= 30; break; case 'M': case 'm': mem <<= 20; break; case 'K': case 'k': mem <<= 10; fallthrough; default: break; } See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation **LONG_LINE** The line has exceeded the specified maximum length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. Earlier, the default line length was 80 columns. Commit bdc48fa11e46 ("checkpatch/coding-style: deprecate 80-column warning") increased the limit to 100 columns. This is not a hard limit either and it's preferable to stay within 80 columns whenever possible. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings **LONG_LINE_STRING** A string starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings **LONG_LINE_COMMENT** A comment starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings **SPLIT_STRING** Quoted strings that appear as messages in userspace and can be grepped, should not be split across multiple lines. See: https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/ **MULTILINE_DEREFERENCE** A single dereferencing identifier spanned on multiple lines like:: struct_identifier->member[index]. member = <foo>; is generally hard to follow. It can easily lead to typos and so makes the code vulnerable to bugs. If fixing the multiple line dereferencing leads to an 80 column violation, then either rewrite the code in a more simple way or if the starting part of the dereferencing identifier is the same and used at multiple places then store it in a temporary variable, and use that temporary variable only at all the places. For example, if there are two dereferencing identifiers:: member1->member2->member3.foo1; member1->member2->member3.foo2; then store the member1->member2->member3 part in a temporary variable. It not only helps to avoid the 80 column violation but also reduces the program size by removing the unnecessary dereferences. But if none of the above methods work then ignore the 80 column violation because it is much easier to read a dereferencing identifier on a single line. **TRAILING_STATEMENTS** Trailing statements (for example after any conditional) should be on the next line. Statements, such as:: if (x == y) break; should be:: if (x == y) break; h]jK ��)}(hhh](jP ��)}(h**CODE_INDENT** Code indent should use tabs instead of spaces. Outside of comments, documentation and Kconfig, spaces are never used for indentation. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation h](jV ��)}(h**CODE_INDENT**h]j\ ��)}(hj��h]h CODE_INDENT}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hCode indent should use tabs instead of spaces. Outside of comments, documentation and Kconfig, spaces are never used for indentation.h]hCode indent should use tabs instead of spaces. Outside of comments, documentation and Kconfig, spaces are never used for indentation.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(hQSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentationh](hSee: }(hj��hhhNhNubj ��)}(hLhttps://www.kernel.org/doc/html/latest/process/coding-style.html#indentationh]hLhttps://www.kernel.org/doc/html/latest/process/coding-style.html#indentation}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX��**DEEP_INDENTATION** Indentation with 6 or more tabs usually indicate overly indented code. It is suggested to refactor excessive indentation of if/else/for/do/while/switch statements. See: https://lore.kernel.org/lkml/1328311239.21255.24.camel@joe2Laptop/ h](jV ��)}(h**DEEP_INDENTATION**h]j\ ��)}(hj��h]hDEEP_INDENTATION}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hFIndentation with 6 or more tabs usually indicate overly indented code.h]hFIndentation with 6 or more tabs usually indicate overly indented code.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ��ubh)}(h\It is suggested to refactor excessive indentation of if/else/for/do/while/switch statements.h]h\It is suggested to refactor excessive indentation of if/else/for/do/while/switch statements.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ��ubh)}(hGSee: https://lore.kernel.org/lkml/1328311239.21255.24.camel@joe2Laptop/h](hSee: }(hj,��hhhNhNubj ��)}(hBhttps://lore.kernel.org/lkml/1328311239.21255.24.camel@joe2Laptop/h]hBhttps://lore.kernel.org/lkml/1328311239.21255.24.camel@joe2Laptop/}(hj4��hhhNhNubah}(h]h ]h"]h$]h&]refurij6��uh1j ��hj,��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX��**SWITCH_CASE_INDENT_LEVEL** switch should be at the same indent as case. Example:: switch (suffix) { case 'G': case 'g': mem <<= 30; break; case 'M': case 'm': mem <<= 20; break; case 'K': case 'k': mem <<= 10; fallthrough; default: break; } See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation h](jV ��)}(h**SWITCH_CASE_INDENT_LEVEL**h]j\ ��)}(hj[��h]hSWITCH_CASE_INDENT_LEVEL}(hj]��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjY��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjU��ubjq ��)}(hhh](h)}(h6switch should be at the same indent as case. Example::h]h5switch should be at the same indent as case. Example:}(hjs��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjp��ubj)��)}(hswitch (suffix) { case 'G': case 'g': mem <<= 30; break; case 'M': case 'm': mem <<= 20; break; case 'K': case 'k': mem <<= 10; fallthrough; default: break; }�����h]hswitch (suffix) { case 'G': case 'g': mem <<= 30; break; case 'M': case 'm': mem <<= 20; break; case 'K': case 'k': mem <<= 10; fallthrough; default: break; }}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjp��ubh)}(hQSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentationh](hSee: }(hj��hhhNhNubj ��)}(hLhttps://www.kernel.org/doc/html/latest/process/coding-style.html#indentationh]hLhttps://www.kernel.org/doc/html/latest/process/coding-style.html#indentation}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjp��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjU��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX��**LONG_LINE** The line has exceeded the specified maximum length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. Earlier, the default line length was 80 columns. Commit bdc48fa11e46 ("checkpatch/coding-style: deprecate 80-column warning") increased the limit to 100 columns. This is not a hard limit either and it's preferable to stay within 80 columns whenever possible. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings h](jV ��)}(h **LONG_LINE**h]j\ ��)}(hj��h]h LONG_LINE}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hThe line has exceeded the specified maximum length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.h]hThe line has exceeded the specified maximum length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(hX��Earlier, the default line length was 80 columns. Commit bdc48fa11e46 ("checkpatch/coding-style: deprecate 80-column warning") increased the limit to 100 columns. This is not a hard limit either and it's preferable to stay within 80 columns whenever possible.h]hX ��Earlier, the default line length was 80 columns. Commit bdc48fa11e46 (“checkpatch/coding-style: deprecate 80-column warning”) increased the limit to 100 columns. This is not a hard limit either and it’s preferable to stay within 80 columns whenever possible.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(heSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh](hSee: }(hj��hhhNhNubj ��)}(h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh]h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX.��**LONG_LINE_STRING** A string starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings h](jV ��)}(h**LONG_LINE_STRING**h]j\ ��)}(hj!��h]hLONG_LINE_STRING}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hA string starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.h]hA string starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.}(hj9��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj6��ubh)}(heSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh](hSee: }(hjG��hhhNhNubj ��)}(h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh]h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings}(hjO��hhhNhNubah}(h]h ]h"]h$]h&]refurijQ��uh1j ��hjG��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj6��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX0��**LONG_LINE_COMMENT** A comment starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings h](jV ��)}(h**LONG_LINE_COMMENT**h]j\ ��)}(hjv��h]hLONG_LINE_COMMENT}(hjx��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjt��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjp��ubjq ��)}(hhh](h)}(hA comment starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.h]hA comment starts before but extends beyond the maximum line length. To use a different maximum line length, the --max-line-length=n option may be added while invoking checkpatch.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(heSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh](hSee: }(hj��hhhNhNubj ��)}(h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-stringsh]h`https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjp��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(h**SPLIT_STRING** Quoted strings that appear as messages in userspace and can be grepped, should not be split across multiple lines. See: https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/ h](jV ��)}(h**SPLIT_STRING**h]j\ ��)}(hj��h]h SPLIT_STRING}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hrQuoted strings that appear as messages in userspace and can be grepped, should not be split across multiple lines.h]hrQuoted strings that appear as messages in userspace and can be grepped, should not be split across multiple lines.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(h>See: https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/h](hSee: }(hj��hhhNhNubj ��)}(h9https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/h]h9https://lore.kernel.org/lkml/20120203052727.GA15035@leaf/}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(hX��**MULTILINE_DEREFERENCE** A single dereferencing identifier spanned on multiple lines like:: struct_identifier->member[index]. member = <foo>; is generally hard to follow. It can easily lead to typos and so makes the code vulnerable to bugs. If fixing the multiple line dereferencing leads to an 80 column violation, then either rewrite the code in a more simple way or if the starting part of the dereferencing identifier is the same and used at multiple places then store it in a temporary variable, and use that temporary variable only at all the places. For example, if there are two dereferencing identifiers:: member1->member2->member3.foo1; member1->member2->member3.foo2; then store the member1->member2->member3 part in a temporary variable. It not only helps to avoid the 80 column violation but also reduces the program size by removing the unnecessary dereferences. But if none of the above methods work then ignore the 80 column violation because it is much easier to read a dereferencing identifier on a single line. h](jV ��)}(h**MULTILINE_DEREFERENCE**h]j\ ��)}(hj ��h]hMULTILINE_DEREFERENCE}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hBA single dereferencing identifier spanned on multiple lines like::h]hAA single dereferencing identifier spanned on multiple lines like:}(hj8��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5��ubj)��)}(h1struct_identifier->member[index]. member = <foo>;h]h1struct_identifier->member[index]. member = <foo>;}hjF��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj5��ubh)}(hbis generally hard to follow. It can easily lead to typos and so makes the code vulnerable to bugs.h]hbis generally hard to follow. It can easily lead to typos and so makes the code vulnerable to bugs.}(hjT��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5��ubh)}(hXu��If fixing the multiple line dereferencing leads to an 80 column violation, then either rewrite the code in a more simple way or if the starting part of the dereferencing identifier is the same and used at multiple places then store it in a temporary variable, and use that temporary variable only at all the places. For example, if there are two dereferencing identifiers::h]hXt��If fixing the multiple line dereferencing leads to an 80 column violation, then either rewrite the code in a more simple way or if the starting part of the dereferencing identifier is the same and used at multiple places then store it in a temporary variable, and use that temporary variable only at all the places. For example, if there are two dereferencing identifiers:}(hjb��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5��ubj)��)}(h?member1->member2->member3.foo1; member1->member2->member3.foo2;h]h?member1->member2->member3.foo1; member1->member2->member3.foo2;}hjp��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj5��ubh)}(hthen store the member1->member2->member3 part in a temporary variable. It not only helps to avoid the 80 column violation but also reduces the program size by removing the unnecessary dereferences.h]hthen store the member1->member2->member3 part in a temporary variable. It not only helps to avoid the 80 column violation but also reduces the program size by removing the unnecessary dereferences.}(hj~��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5��ubh)}(hBut if none of the above methods work then ignore the 80 column violation because it is much easier to read a dereferencing identifier on a single line.h]hBut if none of the above methods work then ignore the 80 column violation because it is much easier to read a dereferencing identifier on a single line.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubjP ��)}(h**TRAILING_STATEMENTS** Trailing statements (for example after any conditional) should be on the next line. Statements, such as:: if (x == y) break; should be:: if (x == y) break; h](jV ��)}(h**TRAILING_STATEMENTS**h]j\ ��)}(hj��h]hTRAILING_STATEMENTS}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hiTrailing statements (for example after any conditional) should be on the next line. Statements, such as::h]hhTrailing statements (for example after any conditional) should be on the next line. Statements, such as:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubj)��)}(hif (x == y) break;h]hif (x == y) break;}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj��ubh)}(h should be::h]h should be:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubj)��)}(hif (x == y) break;h]hif (x == y) break;}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhj��hhubeh}(h]indentation-and-line-breaksah ]h"]indentation and line breaksah$]h&]uh1hhj��hhhhhMubh)}(hhh](h)}(hMacros, Attributes and Symbolsh]hMacros, Attributes and Symbols}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj��hhhhhM�ubjG��)}(hX��**ARRAY_SIZE** The ARRAY_SIZE(foo) macro should be preferred over sizeof(foo)/sizeof(foo[0]) for finding number of elements in an array. The macro is defined in include/linux/array_size.h:: #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) **AVOID_EXTERNS** Function prototypes don't need to be declared extern in .h files. It's assumed by the compiler and is unnecessary. **AVOID_L_PREFIX** Local symbol names that are prefixed with `.L` should be avoided, as this has special meaning for the assembler; a symbol entry will not be emitted into the symbol table. This can prevent `objtool` from generating correct unwind info. Symbols with STB_LOCAL binding may still be used, and `.L` prefixed local symbol names are still generally usable within a function, but `.L` prefixed local symbol names should not be used to denote the beginning or end of code regions via `SYM_CODE_START_LOCAL`/`SYM_CODE_END` **BIT_MACRO** Defines like: 1 << <digit> could be BIT(digit). The BIT() macro is defined via include/linux/bits.h:: #define BIT(nr) (1UL << (nr)) **CONST_READ_MOSTLY** When a variable is tagged with the __read_mostly annotation, it is a signal to the compiler that accesses to the variable will be mostly reads and rarely(but NOT never) a write. const __read_mostly does not make any sense as const data is already read-only. The __read_mostly annotation thus should be removed. **DATE_TIME** It is generally desirable that building the same source code with the same set of tools is reproducible, i.e. the output is always exactly the same. The kernel does *not* use the ``__DATE__`` and ``__TIME__`` macros, and enables warnings if they are used as they can lead to non-deterministic builds. See: https://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestamps **DEFINE_ARCH_HAS** The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong. For big conceptual features use Kconfig symbols instead. And for smaller things where we have compatibility fallback functions but want architectures able to override them with optimized ones, we should either use weak functions (appropriate for some cases), or the symbol that protects them should be the same symbol we use. See: https://lore.kernel.org/lkml/CA+55aFycQ9XJvEOsiM3txHL5bjUc8CeKWJNR_H+MiicaddB42Q@mail.gmail.com/ **DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON** do {} while(0) macros should not have a trailing semicolon. **INIT_ATTRIBUTE** Const init definitions should use __initconst instead of __initdata. Similarly init definitions without const require a separate use of const. **INLINE_LOCATION** The inline keyword should sit between storage class and type. For example, the following segment:: inline static int example_function(void) { ... } should be:: static inline int example_function(void) { ... } **MISPLACED_INIT** It is possible to use section markers on variables in a way which gcc doesn't understand (or at least not the way the developer intended):: static struct __initdata samsung_pll_clock exynos4_plls[nr_plls] = { does not put exynos4_plls in the .initdata section. The __initdata marker can be virtually anywhere on the line, except right after "struct". The preferred location is before the "=" sign if there is one, or before the trailing ";" otherwise. See: https://lore.kernel.org/lkml/1377655732.3619.19.camel@joe-AO722/ **MULTISTATEMENT_MACRO_USE_DO_WHILE** Macros with multiple statements should be enclosed in a do - while block. Same should also be the case for macros starting with `if` to avoid logic defects:: #define macrofun(a, b, c) \ do { \ if (a == 5) \ do_this(b, c); \ } while (0) See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl **PREFER_FALLTHROUGH** Use the `fallthrough;` pseudo keyword instead of `/* fallthrough */` like comments. **TRAILING_SEMICOLON** Macro definition should not end with a semicolon. The macro invocation style should be consistent with function calls. This can prevent any unexpected code paths:: #define MAC do_something; If this macro is used within a if else statement, like:: if (some_condition) MAC; else do_something; Then there would be a compilation error, because when the macro is expanded there are two trailing semicolons, so the else branch gets orphaned. See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/ **MACRO_ARG_UNUSED** If function-like macros do not utilize a parameter, it might result in a build warning. We advocate for utilizing static inline functions to replace such macros. For example, for a macro such as the one below:: #define test(a) do { } while (0) there would be a warning like below:: WARNING: Argument 'a' is not used in function-like macro. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl **SINGLE_STATEMENT_DO_WHILE_MACRO** For the multi-statement macros, it is necessary to use the do-while loop to avoid unpredictable code paths. The do-while loop helps to group the multiple statements into a single one so that a function-like macro can be used as a function only. But for the single statement macros, it is unnecessary to use the do-while loop. Although the code is syntactically correct but using the do-while loop is redundant. So remove the do-while loop for single statement macros. **WEAK_DECLARATION** Using weak declarations like __attribute__((weak)) or __weak can have unintended link defects. Avoid using them. h]jK ��)}(hhh](jP ��)}(h**ARRAY_SIZE** The ARRAY_SIZE(foo) macro should be preferred over sizeof(foo)/sizeof(foo[0]) for finding number of elements in an array. The macro is defined in include/linux/array_size.h:: #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) h](jV ��)}(h**ARRAY_SIZE**h]j\ ��)}(hj:��h]h ARRAY_SIZE}(hj<��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj8��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hj4��ubjq ��)}(hhh](h)}(hyThe ARRAY_SIZE(foo) macro should be preferred over sizeof(foo)/sizeof(foo[0]) for finding number of elements in an array.h]hyThe ARRAY_SIZE(foo) macro should be preferred over sizeof(foo)/sizeof(foo[0]) for finding number of elements in an array.}(hjR��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjO��ubh)}(h4The macro is defined in include/linux/array_size.h::h]h3The macro is defined in include/linux/array_size.h:}(hj`��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjO��ubj)��)}(h2#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))h]h2#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))}hjn��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM hjO��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj4��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj1��ubjP ��)}(h**AVOID_EXTERNS** Function prototypes don't need to be declared extern in .h files. It's assumed by the compiler and is unnecessary. h](jV ��)}(h**AVOID_EXTERNS**h]j\ ��)}(hj��h]h AVOID_EXTERNS}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hj��ubjq ��)}(hhh]h)}(hsFunction prototypes don't need to be declared extern in .h files. It's assumed by the compiler and is unnecessary.h]hwFunction prototypes don’t need to be declared extern in .h files. It’s assumed by the compiler and is unnecessary.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj��ubah}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj1��ubjP ��)}(hX��**AVOID_L_PREFIX** Local symbol names that are prefixed with `.L` should be avoided, as this has special meaning for the assembler; a symbol entry will not be emitted into the symbol table. This can prevent `objtool` from generating correct unwind info. Symbols with STB_LOCAL binding may still be used, and `.L` prefixed local symbol names are still generally usable within a function, but `.L` prefixed local symbol names should not be used to denote the beginning or end of code regions via `SYM_CODE_START_LOCAL`/`SYM_CODE_END` h](jV ��)}(h**AVOID_L_PREFIX**h]j\ ��)}(hj��h]hAVOID_L_PREFIX}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj��ubjq ��)}(hhh](h)}(hLocal symbol names that are prefixed with `.L` should be avoided, as this has special meaning for the assembler; a symbol entry will not be emitted into the symbol table. This can prevent `objtool` from generating correct unwind info.h](h*Local symbol names that are prefixed with }(hj��hhhNhNubj��)}(h`.L`h]h.L}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubh should be avoided, as this has special meaning for the assembler; a symbol entry will not be emitted into the symbol table. This can prevent }(hj��hhhNhNubj��)}(h `objtool`h]hobjtool}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubh% from generating correct unwind info.}(hj��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubh)}(hX��Symbols with STB_LOCAL binding may still be used, and `.L` prefixed local symbol names are still generally usable within a function, but `.L` prefixed local symbol names should not be used to denote the beginning or end of code regions via `SYM_CODE_START_LOCAL`/`SYM_CODE_END`h](h6Symbols with STB_LOCAL binding may still be used, and }(hj��hhhNhNubj��)}(h`.L`h]h.L}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubhO prefixed local symbol names are still generally usable within a function, but }(hj��hhhNhNubj��)}(h`.L`h]h.L}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubhc prefixed local symbol names should not be used to denote the beginning or end of code regions via }(hj��hhhNhNubj��)}(h`SYM_CODE_START_LOCAL`h]hSYM_CODE_START_LOCAL}(hj<��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubh/}(hj��hhhNhNubj��)}(h`SYM_CODE_END`h]h SYM_CODE_END}(hjN��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubjP ��)}(h**BIT_MACRO** Defines like: 1 << <digit> could be BIT(digit). The BIT() macro is defined via include/linux/bits.h:: #define BIT(nr) (1UL << (nr)) h](jV ��)}(h **BIT_MACRO**h]j\ ��)}(hjt��h]h BIT_MACRO}(hjv��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjr��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjn��ubjq ��)}(hhh](h)}(heDefines like: 1 << <digit> could be BIT(digit). The BIT() macro is defined via include/linux/bits.h::h]hdDefines like: 1 << <digit> could be BIT(digit). The BIT() macro is defined via include/linux/bits.h:}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj��ubj)��)}(h%#define BIT(nr) (1UL << (nr))h]h%#define BIT(nr) (1UL << (nr))}hj��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjn��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubjP ��)}(hXO��**CONST_READ_MOSTLY** When a variable is tagged with the __read_mostly annotation, it is a signal to the compiler that accesses to the variable will be mostly reads and rarely(but NOT never) a write. const __read_mostly does not make any sense as const data is already read-only. The __read_mostly annotation thus should be removed. h](jV ��)}(h**CONST_READ_MOSTLY**h]j\ ��)}(hj��h]hCONST_READ_MOSTLY}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM'hj��ubjq ��)}(hhh](h)}(hWhen a variable is tagged with the __read_mostly annotation, it is a signal to the compiler that accesses to the variable will be mostly reads and rarely(but NOT never) a write.h]hWhen a variable is tagged with the __read_mostly annotation, it is a signal to the compiler that accesses to the variable will be mostly reads and rarely(but NOT never) a write.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj��ubh)}(hconst __read_mostly does not make any sense as const data is already read-only. The __read_mostly annotation thus should be removed.h]hconst __read_mostly does not make any sense as const data is already read-only. The __read_mostly annotation thus should be removed.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM'hj1��ubjP ��)}(hX��**DATE_TIME** It is generally desirable that building the same source code with the same set of tools is reproducible, i.e. the output is always exactly the same. The kernel does *not* use the ``__DATE__`` and ``__TIME__`` macros, and enables warnings if they are used as they can lead to non-deterministic builds. See: https://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestamps h](jV ��)}(h **DATE_TIME**h]j\ ��)}(hj���h]h DATE_TIME}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM2hj��ubjq ��)}(hhh](h)}(hIt is generally desirable that building the same source code with the same set of tools is reproducible, i.e. the output is always exactly the same.h]hIt is generally desirable that building the same source code with the same set of tools is reproducible, i.e. the output is always exactly the same.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM*hj��ubh)}(hThe kernel does *not* use the ``__DATE__`` and ``__TIME__`` macros, and enables warnings if they are used as they can lead to non-deterministic builds.h](hThe kernel does }(hj&��hhhNhNubj��)}(h*not*h]hnot}(hj.��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj&��ubh use the }(hj&��hhhNhNubj��)}(h ``__DATE__``h]h__DATE__}(hj@��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj&��ubh and }(hj&��hhhNhNubj��)}(h ``__TIME__``h]h__TIME__}(hjR��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj&��ubh\ macros, and enables warnings if they are used as they can lead to non-deterministic builds.}(hj&��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM.hj��ubh)}(hVSee: https://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestampsh](hSee: }(hjj��hhhNhNubj ��)}(hQhttps://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestampsh]hQhttps://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestamps}(hjr��hhhNhNubah}(h]h ]h"]h$]h&]refurijt��uh1j ��hjj��ubeh}(h]h ]h"]h$]h&]uh1hhhhM2hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM2hj1��ubjP ��)}(hX��**DEFINE_ARCH_HAS** The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong. For big conceptual features use Kconfig symbols instead. And for smaller things where we have compatibility fallback functions but want architectures able to override them with optimized ones, we should either use weak functions (appropriate for some cases), or the symbol that protects them should be the same symbol we use. See: https://lore.kernel.org/lkml/CA+55aFycQ9XJvEOsiM3txHL5bjUc8CeKWJNR_H+MiicaddB42Q@mail.gmail.com/ h](jV ��)}(h**DEFINE_ARCH_HAS**h]j\ ��)}(hj��h]hDEFINE_ARCH_HAS}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM=hj��ubjq ��)}(hhh](h)}(h6The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong.h]h6The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM5hj��ubh)}(hXF��For big conceptual features use Kconfig symbols instead. And for smaller things where we have compatibility fallback functions but want architectures able to override them with optimized ones, we should either use weak functions (appropriate for some cases), or the symbol that protects them should be the same symbol we use.h]hXF��For big conceptual features use Kconfig symbols instead. And for smaller things where we have compatibility fallback functions but want architectures able to override them with optimized ones, we should either use weak functions (appropriate for some cases), or the symbol that protects them should be the same symbol we use.}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM7hj��ubh)}(heSee: https://lore.kernel.org/lkml/CA+55aFycQ9XJvEOsiM3txHL5bjUc8CeKWJNR_H+MiicaddB42Q@mail.gmail.com/h](hSee: }(hj��hhhNhNubj ��)}(h`https://lore.kernel.org/lkml/CA+55aFycQ9XJvEOsiM3txHL5bjUc8CeKWJNR_H+MiicaddB42Q@mail.gmail.com/h]h`https://lore.kernel.org/lkml/CA+55aFycQ9XJvEOsiM3txHL5bjUc8CeKWJNR_H+MiicaddB42Q@mail.gmail.com/}(hj��hhhNhNubah}(h]h ]h"]h$]h&]refurij��uh1j ��hj��ubeh}(h]h ]h"]h$]h&]uh1hhhhM=hj��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM=hj1��ubjP ��)}(hg**DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON** do {} while(0) macros should not have a trailing semicolon. h](jV ��)}(h***DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON**h]j\ ��)}(hj��h]h&DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON}(hj��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM@hj��ubjq ��)}(hhh]h)}(h;do {} while(0) macros should not have a trailing semicolon.h]h;do {} while(0) macros should not have a trailing semicolon.}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM@hj ��ubah}(h]h ]h"]h$]h&]uh1jp ��hj��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM@hj1��ubjP ��)}(h**INIT_ATTRIBUTE** Const init definitions should use __initconst instead of __initdata. Similarly init definitions without const require a separate use of const. h](jV ��)}(h**INIT_ATTRIBUTE**h]j\ ��)}(hj4 ��h]hINIT_ATTRIBUTE}(hj6 ��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj2 ��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMGhj. ��ubjq ��)}(hhh](h)}(hDConst init definitions should use __initconst instead of __initdata.h]hDConst init definitions should use __initconst instead of __initdata.}(hjL ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMChjI ��ubh)}(hISimilarly init definitions without const require a separate use of const.h]hISimilarly init definitions without const require a separate use of const.}(hjZ ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhjI ��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj. ��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMGhj1��ubjP ��)}(hX ��**INLINE_LOCATION** The inline keyword should sit between storage class and type. For example, the following segment:: inline static int example_function(void) { ... } should be:: static inline int example_function(void) { ... } h](jV ��)}(h**INLINE_LOCATION**h]j\ ��)}(hjz ��h]hINLINE_LOCATION}(hj| ��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjx ��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMXhjt ��ubjq ��)}(hhh](h)}(h=The inline keyword should sit between storage class and type.h]h=The inline keyword should sit between storage class and type.}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMJhj ��ubh)}(h$For example, the following segment::h]h#For example, the following segment:}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhj ��ubj)��)}(h8inline static int example_function(void) { ... }h]h8inline static int example_function(void) { ... }}hj ��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMNhj ��ubh)}(h should be::h]h should be:}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMShj ��ubj)��)}(h8static inline int example_function(void) { ... }h]h8static inline int example_function(void) { ... }}hj ��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMUhj ��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjt ��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMXhj1��ubjP ��)}(hX"��**MISPLACED_INIT** It is possible to use section markers on variables in a way which gcc doesn't understand (or at least not the way the developer intended):: static struct __initdata samsung_pll_clock exynos4_plls[nr_plls] = { does not put exynos4_plls in the .initdata section. The __initdata marker can be virtually anywhere on the line, except right after "struct". The preferred location is before the "=" sign if there is one, or before the trailing ";" otherwise. See: https://lore.kernel.org/lkml/1377655732.3619.19.camel@joe-AO722/ h](jV ��)}(h**MISPLACED_INIT**h]j\ ��)}(hj ��h]hMISPLACED_INIT}(hj ��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj ��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMfhj ��ubjq ��)}(hhh](h)}(hIt is possible to use section markers on variables in a way which gcc doesn't understand (or at least not the way the developer intended)::h]hIt is possible to use section markers on variables in a way which gcc doesn’t understand (or at least not the way the developer intended):}(hj!��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hj ��ubj)��)}(hDstatic struct __initdata samsung_pll_clock exynos4_plls[nr_plls] = {h]hDstatic struct __initdata samsung_pll_clock exynos4_plls[nr_plls] = {}hj!��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM_hj ��ubh)}(hdoes not put exynos4_plls in the .initdata section. The __initdata marker can be virtually anywhere on the line, except right after "struct". The preferred location is before the "=" sign if there is one, or before the trailing ";" otherwise.h]hdoes not put exynos4_plls in the .initdata section. The __initdata marker can be virtually anywhere on the line, except right after “struct”. The preferred location is before the “=” sign if there is one, or before the trailing “;” otherwise.}(hj!��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahj ��ubh)}(hESee: https://lore.kernel.org/lkml/1377655732.3619.19.camel@joe-AO722/h](hSee: }(hj,!��hhhNhNubj ��)}(h@https://lore.kernel.org/lkml/1377655732.3619.19.camel@joe-AO722/h]h@https://lore.kernel.org/lkml/1377655732.3619.19.camel@joe-AO722/}(hj4!��hhhNhNubah}(h]h ]h"]h$]h&]refurij6!��uh1j ��hj,!��ubeh}(h]h ]h"]h$]h&]uh1hhhhMfhj ��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj ��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMfhj1��ubjP ��)}(hX��**MULTISTATEMENT_MACRO_USE_DO_WHILE** Macros with multiple statements should be enclosed in a do - while block. Same should also be the case for macros starting with `if` to avoid logic defects:: #define macrofun(a, b, c) \ do { \ if (a == 5) \ do_this(b, c); \ } while (0) See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl h](jV ��)}(h%**MULTISTATEMENT_MACRO_USE_DO_WHILE**h]j\ ��)}(hj[!��h]h!MULTISTATEMENT_MACRO_USE_DO_WHILE}(hj]!��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjY!��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMshjU!��ubjq ��)}(hhh](h)}(hMacros with multiple statements should be enclosed in a do - while block. Same should also be the case for macros starting with `if` to avoid logic defects::h](hMacros with multiple statements should be enclosed in a do - while block. Same should also be the case for macros starting with }(hjs!��hhhNhNubj��)}(h`if`h]hif}(hj{!��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hjs!��ubh to avoid logic defects:}(hjs!��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMihjp!��ubj)��)}(h#define macrofun(a, b, c) \ do { \ if (a == 5) \ do_this(b, c); \ } while (0)h]h#define macrofun(a, b, c) \ do { \ if (a == 5) \ do_this(b, c); \ } while (0)}hj!��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMmhjp!��ubh)}(hZSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtlh](hSee: }(hj!��hhhNhNubj ��)}(hUhttps://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtlh]hUhttps://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl}(hj!��hhhNhNubah}(h]h ]h"]h$]h&]refurij!��uh1j ��hj!��ubeh}(h]h ]h"]h$]h&]uh1hhhhMshjp!��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjU!��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMshj1��ubjP ��)}(hk**PREFER_FALLTHROUGH** Use the `fallthrough;` pseudo keyword instead of `/* fallthrough */` like comments. h](jV ��)}(h**PREFER_FALLTHROUGH**h]j\ ��)}(hj!��h]hPREFER_FALLTHROUGH}(hj!��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj!��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMwhj!��ubjq ��)}(hhh]h)}(hSUse the `fallthrough;` pseudo keyword instead of `/* fallthrough */` like comments.h](hUse the }(hj!��hhhNhNubj��)}(h`fallthrough;`h]h fallthrough;}(hj!��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj!��ubh pseudo keyword instead of }(hj!��hhhNhNubj��)}(h`/* fallthrough */`h]h/* fallthrough */}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj!��ubh like comments.}(hj!��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMvhj!��ubah}(h]h ]h"]h$]h&]uh1jp ��hj!��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMwhj1��ubjP ��)}(hX1��**TRAILING_SEMICOLON** Macro definition should not end with a semicolon. The macro invocation style should be consistent with function calls. This can prevent any unexpected code paths:: #define MAC do_something; If this macro is used within a if else statement, like:: if (some_condition) MAC; else do_something; Then there would be a compilation error, because when the macro is expanded there are two trailing semicolons, so the else branch gets orphaned. See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/ h](jV ��)}(h**TRAILING_SEMICOLON**h]j\ ��)}(hj,"��h]hTRAILING_SEMICOLON}(hj."��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj*"��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj&"��ubjq ��)}(hhh](h)}(hMacro definition should not end with a semicolon. The macro invocation style should be consistent with function calls. This can prevent any unexpected code paths::h]hMacro definition should not end with a semicolon. The macro invocation style should be consistent with function calls. This can prevent any unexpected code paths:}(hjD"��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMzhjA"��ubj)��)}(h#define MAC do_something;h]h#define MAC do_something;}hjR"��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM~hjA"��ubh)}(h8If this macro is used within a if else statement, like::h]h7If this macro is used within a if else statement, like:}(hj`"��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjA"��ubj)��)}(h<if (some_condition) MAC; else do_something;h]h<if (some_condition) MAC; else do_something;}hjn"��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjA"��ubh)}(hThen there would be a compilation error, because when the macro is expanded there are two trailing semicolons, so the else branch gets orphaned.h]hThen there would be a compilation error, because when the macro is expanded there are two trailing semicolons, so the else branch gets orphaned.}(hj|"��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjA"��ubh)}(hESee: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/h](hSee: }(hj"��hhhNhNubj ��)}(h@https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/h]h@https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]refurij"��uh1j ��hj"��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjA"��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj&"��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubjP ��)}(hX��**MACRO_ARG_UNUSED** If function-like macros do not utilize a parameter, it might result in a build warning. We advocate for utilizing static inline functions to replace such macros. For example, for a macro such as the one below:: #define test(a) do { } while (0) there would be a warning like below:: WARNING: Argument 'a' is not used in function-like macro. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl h](jV ��)}(h**MACRO_ARG_UNUSED**h]j\ ��)}(hj"��h]hMACRO_ARG_UNUSED}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj"��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj"��ubjq ��)}(hhh](h)}(hIf function-like macros do not utilize a parameter, it might result in a build warning. We advocate for utilizing static inline functions to replace such macros. For example, for a macro such as the one below::h]hIf function-like macros do not utilize a parameter, it might result in a build warning. We advocate for utilizing static inline functions to replace such macros. For example, for a macro such as the one below:}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"��ubj)��)}(h #define test(a) do { } while (0)h]h #define test(a) do { } while (0)}hj"��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj"��ubh)}(h%there would be a warning like below::h]h$there would be a warning like below:}(hj"��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"��ubj)��)}(h9WARNING: Argument 'a' is not used in function-like macro.h]h9WARNING: Argument 'a' is not used in function-like macro.}hj"��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj"��ubh)}(hZSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtlh](hSee: }(hj #��hhhNhNubj ��)}(hUhttps://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtlh]hUhttps://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]refurij#��uh1j ��hj #��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj"��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubjP ��)}(hX��**SINGLE_STATEMENT_DO_WHILE_MACRO** For the multi-statement macros, it is necessary to use the do-while loop to avoid unpredictable code paths. The do-while loop helps to group the multiple statements into a single one so that a function-like macro can be used as a function only. But for the single statement macros, it is unnecessary to use the do-while loop. Although the code is syntactically correct but using the do-while loop is redundant. So remove the do-while loop for single statement macros. h](jV ��)}(h#**SINGLE_STATEMENT_DO_WHILE_MACRO**h]j\ ��)}(hj8#��h]hSINGLE_STATEMENT_DO_WHILE_MACRO}(hj:#��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj6#��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj2#��ubjq ��)}(hhh](h)}(hFor the multi-statement macros, it is necessary to use the do-while loop to avoid unpredictable code paths. The do-while loop helps to group the multiple statements into a single one so that a function-like macro can be used as a function only.h]hFor the multi-statement macros, it is necessary to use the do-while loop to avoid unpredictable code paths. The do-while loop helps to group the multiple statements into a single one so that a function-like macro can be used as a function only.}(hjP#��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjM#��ubh)}(hBut for the single statement macros, it is unnecessary to use the do-while loop. Although the code is syntactically correct but using the do-while loop is redundant. So remove the do-while loop for single statement macros.h]hBut for the single statement macros, it is unnecessary to use the do-while loop. Although the code is syntactically correct but using the do-while loop is redundant. So remove the do-while loop for single statement macros.}(hj^#��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjM#��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj2#��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubjP ��)}(h**WEAK_DECLARATION** Using weak declarations like __attribute__((weak)) or __weak can have unintended link defects. Avoid using them. h](jV ��)}(h**WEAK_DECLARATION**h]j\ ��)}(hj~#��h]hWEAK_DECLARATION}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj|#��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjx#��ubjq ��)}(hhh]h)}(hqUsing weak declarations like __attribute__((weak)) or __weak can have unintended link defects. Avoid using them.h]hqUsing weak declarations like __attribute__((weak)) or __weak can have unintended link defects. Avoid using them.}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#��ubah}(h]h ]h"]h$]h&]uh1jp ��hjx#��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj1��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj-��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhj��hhubeh}(h]macros-attributes-and-symbolsah ]h"]macros, attributes and symbolsah$]h&]uh1hhj��hhhhhM�ubh)}(hhh](h)}(hFunctions and Variablesh]hFunctions and Variables}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#��hhhhhMubjG��)}(hX ��**CAMELCASE** Avoid CamelCase Identifiers. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#naming **CONST_CONST** Using `const <type> const *` is generally meant to be written `const <type> * const`. **CONST_STRUCT** Using const is generally a good idea. Checkpatch reads a list of frequently used structs that are always or almost always constant. The existing structs list can be viewed from `scripts/const_structs.checkpatch`. See: https://lore.kernel.org/lkml/alpine.DEB.2.10.1608281509480.3321@hadrien/ **EMBEDDED_FUNCTION_NAME** Embedded function names are less appropriate to use as refactoring can cause function renaming. Prefer the use of "%s", __func__ to embedded function names. Note that this does not work with -f (--file) checkpatch option as it depends on patch context providing the function name. **FUNCTION_ARGUMENTS** This warning is emitted due to any of the following reasons: 1. Arguments for the function declaration do not follow the identifier name. Example:: void foo (int bar, int baz) This should be corrected to:: void foo(int bar, int baz) 2. Some arguments for the function definition do not have an identifier name. Example:: void foo(int) All arguments should have identifier names. **FUNCTION_WITHOUT_ARGS** Function declarations without arguments like:: int foo() should be:: int foo(void) **GLOBAL_INITIALISERS** Global variables should not be initialized explicitly to 0 (or NULL, false, etc.). Your compiler (or rather your loader, which is responsible for zeroing out the relevant sections) automatically does it for you. **INITIALISED_STATIC** Static variables should not be initialized explicitly to zero. Your compiler (or rather your loader) automatically does it for you. **MULTIPLE_ASSIGNMENTS** Multiple assignments on a single line makes the code unnecessarily complicated. So on a single line assign value to a single variable only, this makes the code more readable and helps avoid typos. **RETURN_PARENTHESES** return is not a function and as such doesn't need parentheses:: return (bar); can simply be:: return bar; **UNINITIALIZED_PTR_WITH_FREE** Pointers with __free attribute should be declared at the place of use and initialized (see include/linux/cleanup.h). In this case declarations at the top of the function rule can be relaxed. Not doing so may lead to undefined behavior as the memory assigned (garbage, in case not initialized) to the pointer is freed automatically when the pointer goes out of scope. Also see: https://lore.kernel.org/lkml/58fd478f408a34b578ee8d949c5c4b4da4d4f41d.camel@HansenPartnership.com/ Example:: type var __free(free_func); ... // var not used, but, in future someone might add a return here var = malloc(var_size); ... should be initialized as:: ... type var __free(free_func) = malloc(var_size); ... h]jK ��)}(hhh](jP ��)}(hy**CAMELCASE** Avoid CamelCase Identifiers. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#naming h](jV ��)}(h **CAMELCASE**h]j\ ��)}(hj#��h]h CAMELCASE}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj#��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj#��ubjq ��)}(hhh](h)}(hAvoid CamelCase Identifiers.h]hAvoid CamelCase Identifiers.}(hj#��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#��ubh)}(hLSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#namingh](hSee: }(hj$��hhhNhNubj ��)}(hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#namingh]hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#naming}(hj$��hhhNhNubah}(h]h ]h"]h$]h&]refurij$��uh1j ��hj$��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj#��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj#��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(hf**CONST_CONST** Using `const <type> const *` is generally meant to be written `const <type> * const`. h](jV ��)}(h**CONST_CONST**h]j\ ��)}(hj7$��h]h CONST_CONST}(hj9$��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj5$��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj1$��ubjq ��)}(hhh]h)}(hUUsing `const <type> const *` is generally meant to be written `const <type> * const`.h](hUsing }(hjO$��hhhNhNubj��)}(h`const <type> const *`h]hconst <type> const *}(hjW$��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hjO$��ubh" is generally meant to be written }(hjO$��hhhNhNubj��)}(h`const <type> * const`h]hconst <type> * const}(hji$��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hjO$��ubh.}(hjO$��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjL$��ubah}(h]h ]h"]h$]h&]uh1jp ��hj1$��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(hX7��**CONST_STRUCT** Using const is generally a good idea. Checkpatch reads a list of frequently used structs that are always or almost always constant. The existing structs list can be viewed from `scripts/const_structs.checkpatch`. See: https://lore.kernel.org/lkml/alpine.DEB.2.10.1608281509480.3321@hadrien/ h](jV ��)}(h**CONST_STRUCT**h]j\ ��)}(hj$��h]h CONST_STRUCT}(hj$��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj$��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj$��ubjq ��)}(hhh](h)}(hUsing const is generally a good idea. Checkpatch reads a list of frequently used structs that are always or almost always constant.h]hUsing const is generally a good idea. Checkpatch reads a list of frequently used structs that are always or almost always constant.}(hj$��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$��ubh)}(hPThe existing structs list can be viewed from `scripts/const_structs.checkpatch`.h](h-The existing structs list can be viewed from }(hj$��hhhNhNubj��)}(h"`scripts/const_structs.checkpatch`h]h scripts/const_structs.checkpatch}(hj$��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj$��ubh.}(hj$��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj$��ubh)}(hMSee: https://lore.kernel.org/lkml/alpine.DEB.2.10.1608281509480.3321@hadrien/h](hSee: }(hj$��hhhNhNubj ��)}(hHhttps://lore.kernel.org/lkml/alpine.DEB.2.10.1608281509480.3321@hadrien/h]hHhttps://lore.kernel.org/lkml/alpine.DEB.2.10.1608281509480.3321@hadrien/}(hj$��hhhNhNubah}(h]h ]h"]h$]h&]refurij$��uh1j ��hj$��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj$��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj$��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(hX6��**EMBEDDED_FUNCTION_NAME** Embedded function names are less appropriate to use as refactoring can cause function renaming. Prefer the use of "%s", __func__ to embedded function names. Note that this does not work with -f (--file) checkpatch option as it depends on patch context providing the function name. h](jV ��)}(h**EMBEDDED_FUNCTION_NAME**h]j\ ��)}(hj%��h]hEMBEDDED_FUNCTION_NAME}(hj %��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj%��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj%��ubjq ��)}(hhh](h)}(hEmbedded function names are less appropriate to use as refactoring can cause function renaming. Prefer the use of "%s", __func__ to embedded function names.h]hEmbedded function names are less appropriate to use as refactoring can cause function renaming. Prefer the use of “%s”, __func__ to embedded function names.}(hj %��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%��ubh)}(h{Note that this does not work with -f (--file) checkpatch option as it depends on patch context providing the function name.h]h{Note that this does not work with -f (--file) checkpatch option as it depends on patch context providing the function name.}(hj.%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj%��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(hX��**FUNCTION_ARGUMENTS** This warning is emitted due to any of the following reasons: 1. Arguments for the function declaration do not follow the identifier name. Example:: void foo (int bar, int baz) This should be corrected to:: void foo(int bar, int baz) 2. Some arguments for the function definition do not have an identifier name. Example:: void foo(int) All arguments should have identifier names. h](jV ��)}(h**FUNCTION_ARGUMENTS**h]j\ ��)}(hjN%��h]hFUNCTION_ARGUMENTS}(hjP%��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjL%��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjH%��ubjq ��)}(hhh](h)}(h<This warning is emitted due to any of the following reasons:h]h<This warning is emitted due to any of the following reasons:}(hjf%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjc%��ubjG��)}(hXf��1. Arguments for the function declaration do not follow the identifier name. Example:: void foo (int bar, int baz) This should be corrected to:: void foo(int bar, int baz) 2. Some arguments for the function definition do not have an identifier name. Example:: void foo(int) All arguments should have identifier names. h]j��)}(hhh](jR��)}(hArguments for the function declaration do not follow the identifier name. Example:: void foo (int bar, int baz) This should be corrected to:: void foo(int bar, int baz) h](h)}(hTArguments for the function declaration do not follow the identifier name. Example::h]hSArguments for the function declaration do not follow the identifier name. Example:}(hj%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{%��ubj)��)}(hvoid foo (int bar, int baz)h]hvoid foo (int bar, int baz)}hj%��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj{%��ubh)}(hThis should be corrected to::h]hThis should be corrected to:}(hj%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{%��ubj)��)}(hvoid foo(int bar, int baz)h]hvoid foo(int bar, int baz)}hj%��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj{%��ubeh}(h]h ]h"]h$]h&]uh1jQ��hjx%��ubjR��)}(hSome arguments for the function definition do not have an identifier name. Example:: void foo(int) All arguments should have identifier names. h](h)}(hUSome arguments for the function definition do not have an identifier name. Example::h]hTSome arguments for the function definition do not have an identifier name. Example:}(hj%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%��ubj)��)}(h void foo(int)h]h void foo(int)}hj%��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj%��ubh)}(h+All arguments should have identifier names.h]h+All arguments should have identifier names.}(hj%��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%��ubeh}(h]h ]h"]h$]h&]uh1jQ��hjx%��ubeh}(h]h ]h"]h$]h&]j2��j3��j4��hj5��j6��uh1j��hjt%��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhjc%��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjH%��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(ht**FUNCTION_WITHOUT_ARGS** Function declarations without arguments like:: int foo() should be:: int foo(void) h](jV ��)}(h**FUNCTION_WITHOUT_ARGS**h]j\ ��)}(hj&��h]hFUNCTION_WITHOUT_ARGS}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj &��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj &��ubjq ��)}(hhh](h)}(h.Function declarations without arguments like::h]h-Function declarations without arguments like:}(hj'&��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$&��ubj)��)}(h int foo()h]h int foo()}hj5&��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj$&��ubh)}(h should be::h]h should be:}(hjC&��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$&��ubj)��)}(h int foo(void)h]h int foo(void)}hjQ&��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj$&��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj &��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(h**GLOBAL_INITIALISERS** Global variables should not be initialized explicitly to 0 (or NULL, false, etc.). Your compiler (or rather your loader, which is responsible for zeroing out the relevant sections) automatically does it for you. h](jV ��)}(h**GLOBAL_INITIALISERS**h]j\ ��)}(hjq&��h]hGLOBAL_INITIALISERS}(hjs&��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjo&��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjk&��ubjq ��)}(hhh]h)}(hGlobal variables should not be initialized explicitly to 0 (or NULL, false, etc.). Your compiler (or rather your loader, which is responsible for zeroing out the relevant sections) automatically does it for you.h]hGlobal variables should not be initialized explicitly to 0 (or NULL, false, etc.). Your compiler (or rather your loader, which is responsible for zeroing out the relevant sections) automatically does it for you.}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj&��ubah}(h]h ]h"]h$]h&]uh1jp ��hjk&��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(h**INITIALISED_STATIC** Static variables should not be initialized explicitly to zero. Your compiler (or rather your loader) automatically does it for you. h](jV ��)}(h**INITIALISED_STATIC**h]j\ ��)}(hj&��h]hINITIALISED_STATIC}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj&��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj&��ubjq ��)}(hhh]h)}(hStatic variables should not be initialized explicitly to zero. Your compiler (or rather your loader) automatically does it for you.h]hStatic variables should not be initialized explicitly to zero. Your compiler (or rather your loader) automatically does it for you.}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj&��ubah}(h]h ]h"]h$]h&]uh1jp ��hj&��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(h**MULTIPLE_ASSIGNMENTS** Multiple assignments on a single line makes the code unnecessarily complicated. So on a single line assign value to a single variable only, this makes the code more readable and helps avoid typos. h](jV ��)}(h**MULTIPLE_ASSIGNMENTS**h]j\ ��)}(hj&��h]hMULTIPLE_ASSIGNMENTS}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj&��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj&��ubjq ��)}(hhh]h)}(hMultiple assignments on a single line makes the code unnecessarily complicated. So on a single line assign value to a single variable only, this makes the code more readable and helps avoid typos.h]hMultiple assignments on a single line makes the code unnecessarily complicated. So on a single line assign value to a single variable only, this makes the code more readable and helps avoid typos.}(hj&��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj&��ubah}(h]h ]h"]h$]h&]uh1jp ��hj&��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(h**RETURN_PARENTHESES** return is not a function and as such doesn't need parentheses:: return (bar); can simply be:: return bar; h](jV ��)}(h**RETURN_PARENTHESES**h]j\ ��)}(hj'��h]hRETURN_PARENTHESES}(hj'��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj'��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj'��ubjq ��)}(hhh](h)}(h?return is not a function and as such doesn't need parentheses::h]h@return is not a function and as such doesn’t need parentheses:}(hj1'��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.'��ubj)��)}(h return (bar);h]h return (bar);}hj?'��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj.'��ubh)}(hcan simply be::h]hcan simply be:}(hjM'��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.'��ubj)��)}(h return bar;h]h return bar;}hj['��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj.'��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj'��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubjP ��)}(hX��**UNINITIALIZED_PTR_WITH_FREE** Pointers with __free attribute should be declared at the place of use and initialized (see include/linux/cleanup.h). In this case declarations at the top of the function rule can be relaxed. Not doing so may lead to undefined behavior as the memory assigned (garbage, in case not initialized) to the pointer is freed automatically when the pointer goes out of scope. Also see: https://lore.kernel.org/lkml/58fd478f408a34b578ee8d949c5c4b4da4d4f41d.camel@HansenPartnership.com/ Example:: type var __free(free_func); ... // var not used, but, in future someone might add a return here var = malloc(var_size); ... should be initialized as:: ... type var __free(free_func) = malloc(var_size); ... ������h](jV ��)}(h**UNINITIALIZED_PTR_WITH_FREE**h]j\ ��)}(hj{'��h]hUNINITIALIZED_PTR_WITH_FREE}(hj}'��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjy'��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhju'��ubjq ��)}(hhh](h)}(hXn��Pointers with __free attribute should be declared at the place of use and initialized (see include/linux/cleanup.h). In this case declarations at the top of the function rule can be relaxed. Not doing so may lead to undefined behavior as the memory assigned (garbage, in case not initialized) to the pointer is freed automatically when the pointer goes out of scope.h]hXn��Pointers with __free attribute should be declared at the place of use and initialized (see include/linux/cleanup.h). In this case declarations at the top of the function rule can be relaxed. Not doing so may lead to undefined behavior as the memory assigned (garbage, in case not initialized) to the pointer is freed automatically when the pointer goes out of scope.}(hj'��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'��ubh)}(hlAlso see: https://lore.kernel.org/lkml/58fd478f408a34b578ee8d949c5c4b4da4d4f41d.camel@HansenPartnership.com/h](h Also see: }(hj'��hhhNhNubj ��)}(hbhttps://lore.kernel.org/lkml/58fd478f408a34b578ee8d949c5c4b4da4d4f41d.camel@HansenPartnership.com/h]hbhttps://lore.kernel.org/lkml/58fd478f408a34b578ee8d949c5c4b4da4d4f41d.camel@HansenPartnership.com/}(hj'��hhhNhNubah}(h]h ]h"]h$]h&]refurij'��uh1j ��hj'��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj'��ubh)}(h Example::h]hExample:}(hj'��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj'��ubj)��)}(h{type var __free(free_func); ... // var not used, but, in future someone might add a return here var = malloc(var_size); ...h]h{type var __free(free_func); ... // var not used, but, in future someone might add a return here var = malloc(var_size); ...}hj'��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM hj'��ubh)}(hshould be initialized as::h]hshould be initialized as:}(hj'��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'��ubj)��)}(h6... type var __free(free_func) = malloc(var_size); ...h]h6... type var __free(free_func) = malloc(var_size); ...}hj'��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj'��ubeh}(h]h ]h"]h$]h&]uh1jp ��hju'��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj#��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj#��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhj#��hhubeh}(h]functions-and-variablesah ]h"]functions and variablesah$]h&]uh1hhj��hhhhhMubh)}(hhh](h)}(h Permissionsh]h Permissions}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(��hhhhhMubjG��)}(hX-��**DEVICE_ATTR_PERMS** The permissions used in DEVICE_ATTR are unusual. Typically only three permissions are used - 0644 (RW), 0444 (RO) and 0200 (WO). See: https://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributes **EXECUTE_PERMISSIONS** There is no reason for source files to be executable. The executable bit can be removed safely. **EXPORTED_WORLD_WRITABLE** Exporting world writable sysfs/debugfs files is usually a bad thing. When done arbitrarily they can introduce serious security bugs. In the past, some of the debugfs vulnerabilities would seemingly allow any local user to write arbitrary values into device registers - a situation from which little good can be expected to emerge. See: https://lore.kernel.org/linux-arm-kernel/cover.1296818921.git.segoon@openwall.com/ **NON_OCTAL_PERMISSIONS** Permission bits should use 4 digit octal permissions (like 0700 or 0444). Avoid using any other base like decimal. **SYMBOLIC_PERMS** Permission bits in the octal form are more readable and easier to understand than their symbolic counterparts because many command-line tools use this notation. Experienced kernel developers have been using these traditional Unix permission bits for decades and so they find it easier to understand the octal notation than the symbolic macros. For example, it is harder to read S_IWUSR|S_IRUGO than 0644, which obscures the developer's intent rather than clarifying it. See: https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/ h]jK ��)}(hhh](jP ��)}(h**DEVICE_ATTR_PERMS** The permissions used in DEVICE_ATTR are unusual. Typically only three permissions are used - 0644 (RW), 0444 (RO) and 0200 (WO). See: https://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributes h](jV ��)}(h**DEVICE_ATTR_PERMS**h]j\ ��)}(hj4(��h]hDEVICE_ATTR_PERMS}(hj6(��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj2(��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hj.(��ubjq ��)}(hhh](h)}(hThe permissions used in DEVICE_ATTR are unusual. Typically only three permissions are used - 0644 (RW), 0444 (RO) and 0200 (WO).h]hThe permissions used in DEVICE_ATTR are unusual. Typically only three permissions are used - 0644 (RW), 0444 (RO) and 0200 (WO).}(hjL(��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjI(��ubh)}(hMSee: https://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributesh](hSee: }(hjZ(��hhhNhNubj ��)}(hHhttps://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributesh]hHhttps://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributes}(hjb(��hhhNhNubah}(h]h ]h"]h$]h&]refurijd(��uh1j ��hjZ(��ubeh}(h]h ]h"]h$]h&]uh1hhhhM hjI(��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj.(��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj+(��ubjP ��)}(hy**EXECUTE_PERMISSIONS** There is no reason for source files to be executable. The executable bit can be removed safely. h](jV ��)}(h**EXECUTE_PERMISSIONS**h]j\ ��)}(hj(��h]hEXECUTE_PERMISSIONS}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj(��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM$hj(��ubjq ��)}(hhh]h)}(h`There is no reason for source files to be executable. The executable bit can be removed safely.h]h`There is no reason for source files to be executable. The executable bit can be removed safely.}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hj(��ubah}(h]h ]h"]h$]h&]uh1jp ��hj(��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM$hj+(��ubjP ��)}(hX��**EXPORTED_WORLD_WRITABLE** Exporting world writable sysfs/debugfs files is usually a bad thing. When done arbitrarily they can introduce serious security bugs. In the past, some of the debugfs vulnerabilities would seemingly allow any local user to write arbitrary values into device registers - a situation from which little good can be expected to emerge. See: https://lore.kernel.org/linux-arm-kernel/cover.1296818921.git.segoon@openwall.com/ h](jV ��)}(h**EXPORTED_WORLD_WRITABLE**h]j\ ��)}(hj(��h]hEXPORTED_WORLD_WRITABLE}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj(��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM-hj(��ubjq ��)}(hhh](h)}(hXJ��Exporting world writable sysfs/debugfs files is usually a bad thing. When done arbitrarily they can introduce serious security bugs. In the past, some of the debugfs vulnerabilities would seemingly allow any local user to write arbitrary values into device registers - a situation from which little good can be expected to emerge.h]hXJ��Exporting world writable sysfs/debugfs files is usually a bad thing. When done arbitrarily they can introduce serious security bugs. In the past, some of the debugfs vulnerabilities would seemingly allow any local user to write arbitrary values into device registers - a situation from which little good can be expected to emerge.}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hj(��ubh)}(hWSee: https://lore.kernel.org/linux-arm-kernel/cover.1296818921.git.segoon@openwall.com/h](hSee: }(hj(��hhhNhNubj ��)}(hRhttps://lore.kernel.org/linux-arm-kernel/cover.1296818921.git.segoon@openwall.com/h]hRhttps://lore.kernel.org/linux-arm-kernel/cover.1296818921.git.segoon@openwall.com/}(hj(��hhhNhNubah}(h]h ]h"]h$]h&]refurij(��uh1j ��hj(��ubeh}(h]h ]h"]h$]h&]uh1hhhhM-hj(��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj(��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM-hj+(��ubjP ��)}(h**NON_OCTAL_PERMISSIONS** Permission bits should use 4 digit octal permissions (like 0700 or 0444). Avoid using any other base like decimal. h](jV ��)}(h**NON_OCTAL_PERMISSIONS**h]j\ ��)}(hj)��h]hNON_OCTAL_PERMISSIONS}(hj)��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj)��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM1hj)��ubjq ��)}(hhh]h)}(hrPermission bits should use 4 digit octal permissions (like 0700 or 0444). Avoid using any other base like decimal.h]hrPermission bits should use 4 digit octal permissions (like 0700 or 0444). Avoid using any other base like decimal.}(hj.)��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM0hj+)��ubah}(h]h ]h"]h$]h&]uh1jp ��hj)��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM1hj+(��ubjP ��)}(hXQ��**SYMBOLIC_PERMS** Permission bits in the octal form are more readable and easier to understand than their symbolic counterparts because many command-line tools use this notation. Experienced kernel developers have been using these traditional Unix permission bits for decades and so they find it easier to understand the octal notation than the symbolic macros. For example, it is harder to read S_IWUSR|S_IRUGO than 0644, which obscures the developer's intent rather than clarifying it. See: https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/ h](jV ��)}(h**SYMBOLIC_PERMS**h]j\ ��)}(hjN)��h]hSYMBOLIC_PERMS}(hjP)��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjL)��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM=hjH)��ubjq ��)}(hhh](h)}(hX��Permission bits in the octal form are more readable and easier to understand than their symbolic counterparts because many command-line tools use this notation. Experienced kernel developers have been using these traditional Unix permission bits for decades and so they find it easier to understand the octal notation than the symbolic macros. For example, it is harder to read S_IWUSR|S_IRUGO than 0644, which obscures the developer's intent rather than clarifying it.h]hX��Permission bits in the octal form are more readable and easier to understand than their symbolic counterparts because many command-line tools use this notation. Experienced kernel developers have been using these traditional Unix permission bits for decades and so they find it easier to understand the octal notation than the symbolic macros. For example, it is harder to read S_IWUSR|S_IRUGO than 0644, which obscures the developer’s intent rather than clarifying it.}(hjf)��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM4hjc)��ubh)}(heSee: https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/h](hSee: }(hjt)��hhhNhNubj ��)}(h`https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/h]h`https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/}(hj|)��hhhNhNubah}(h]h ]h"]h$]h&]refurij~)��uh1j ��hjt)��ubeh}(h]h ]h"]h$]h&]uh1hhhhM<hjc)��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjH)��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM=hj+(��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj'(��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhj(��hhubeh}(h] permissionsah ]h"] permissionsah$]h&]uh1hhj��hhhhhMubh)}(hhh](h)}(hSpacing and Bracketsh]hSpacing and Brackets}(hj)��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)��hhhhhM@ubjG��)}(hX\ ��**ASSIGNMENT_CONTINUATIONS** Assignment operators should not be written at the start of a line but should follow the operand at the previous line. **BRACES** The placement of braces is stylistically incorrect. The preferred way is to put the opening brace last on the line, and put the closing brace first:: if (x is true) { we do y } This applies for all non-functional blocks. However, there is one special case, namely functions: they have the opening brace at the beginning of the next line, thus:: int function(int x) { body of function } See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces **BRACKET_SPACE** Whitespace before opening bracket '[' is prohibited. There are some exceptions: 1. With a type on the left:: int [] a; 2. At the beginning of a line for slice initialisers:: [0...10] = 5, 3. Inside a curly brace:: = { [0...10] = 5 } **CONCATENATED_STRING** Concatenated elements should have a space in between. Example:: printk(KERN_INFO"bar"); should be:: printk(KERN_INFO "bar"); **ELSE_AFTER_BRACE** `else {` should follow the closing block `}` on the same line. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces **LINE_SPACING** Vertical space is wasted given the limited number of lines an editor window can display when multiple blank lines are used. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces **OPEN_BRACE** The opening brace should be following the function definitions on the next line. For any non-functional block it should be on the same line as the last construct. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces **POINTER_LOCATION** When using pointer data or a function that returns a pointer type, the preferred use of * is adjacent to the data name or function name and not adjacent to the type name. Examples:: char *linux_banner; unsigned long long memparse(char *ptr, char **retptr); char *match_strdup(substring_t *s); See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces **SPACING** Whitespace style used in the kernel sources is described in kernel docs. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces **TRAILING_WHITESPACE** Trailing whitespace should always be removed. Some editors highlight the trailing whitespace and cause visual distractions when editing files. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces **UNNECESSARY_PARENTHESES** Parentheses are not required in the following cases: 1. Function pointer uses:: (foo->bar)(); could be:: foo->bar(); 2. Comparisons in if:: if ((foo->bar) && (foo->baz)) if ((foo == bar)) could be:: if (foo->bar && foo->baz) if (foo == bar) 3. addressof/dereference single Lvalues:: &(foo->bar) *(foo->bar) could be:: &foo->bar *foo->bar **WHILE_AFTER_BRACE** while should follow the closing bracket on the same line:: do { ... } while(something); See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces h]jK ��)}(hhh](jP ��)}(h**ASSIGNMENT_CONTINUATIONS** Assignment operators should not be written at the start of a line but should follow the operand at the previous line. h](jV ��)}(h**ASSIGNMENT_CONTINUATIONS**h]j\ ��)}(hj)��h]hASSIGNMENT_CONTINUATIONS}(hj)��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj)��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMDhj)��ubjq ��)}(hhh]h)}(huAssignment operators should not be written at the start of a line but should follow the operand at the previous line.h]huAssignment operators should not be written at the start of a line but should follow the operand at the previous line.}(hj)��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMChj)��ubah}(h]h ]h"]h$]h&]uh1jp ��hj)��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMDhj)��ubjP ��)}(hX��**BRACES** The placement of braces is stylistically incorrect. The preferred way is to put the opening brace last on the line, and put the closing brace first:: if (x is true) { we do y } This applies for all non-functional blocks. However, there is one special case, namely functions: they have the opening brace at the beginning of the next line, thus:: int function(int x) { body of function } See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces h](jV ��)}(h **BRACES**h]j\ ��)}(hj*��h]hBRACES}(hj *��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj*��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMXhj*��ubjq ��)}(hhh](h)}(hThe placement of braces is stylistically incorrect. The preferred way is to put the opening brace last on the line, and put the closing brace first::h]hThe placement of braces is stylistically incorrect. The preferred way is to put the opening brace last on the line, and put the closing brace first:}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMGhj*��ubj)��)}(h"if (x is true) { we do y }h]h"if (x is true) { we do y }}hj-*��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMKhj*��ubh)}(hThis applies for all non-functional blocks. However, there is one special case, namely functions: they have the opening brace at the beginning of the next line, thus::h]hThis applies for all non-functional blocks. However, there is one special case, namely functions: they have the opening brace at the beginning of the next line, thus:}(hj;*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMOhj*��ubj)��)}(h0int function(int x) { body of function }h]h0int function(int x) { body of function }}hjI*��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMShj*��ubh)}(h_See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh](hSee: }(hjW*��hhhNhNubj ��)}(hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh]hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces}(hj_*��hhhNhNubah}(h]h ]h"]h$]h&]refurija*��uh1j ��hjW*��ubeh}(h]h ]h"]h$]h&]uh1hhhhMXhj*��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj*��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMXhj)��ubjP ��)}(hX ��**BRACKET_SPACE** Whitespace before opening bracket '[' is prohibited. There are some exceptions: 1. With a type on the left:: int [] a; 2. At the beginning of a line for slice initialisers:: [0...10] = 5, 3. Inside a curly brace:: = { [0...10] = 5 } h](jV ��)}(h**BRACKET_SPACE**h]j\ ��)}(hj*��h]h BRACKET_SPACE}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj*��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhhj*��ubjq ��)}(hhh](h)}(hOWhitespace before opening bracket '[' is prohibited. There are some exceptions:h]hSWhitespace before opening bracket ‘[’ is prohibited. There are some exceptions:}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hj*��ubj��)}(hhh](jR��)}(h&With a type on the left:: int [] a; h](h)}(hWith a type on the left::h]hWith a type on the left:}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM^hj*��ubj)��)}(h int [] a;h]h int [] a;}hj*��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhM`hj*��ubeh}(h]h ]h"]h$]h&]uh1jQ��hj*��ubjR��)}(hDAt the beginning of a line for slice initialisers:: [0...10] = 5, h](h)}(h3At the beginning of a line for slice initialisers::h]h2At the beginning of a line for slice initialisers:}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMbhj*��ubj)��)}(h [0...10] = 5,h]h [0...10] = 5,}hj*��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMdhj*��ubeh}(h]h ]h"]h$]h&]uh1jQ��hj*��ubjR��)}(h,Inside a curly brace:: = { [0...10] = 5 } h](h)}(hInside a curly brace::h]hInside a curly brace:}(hj*��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMfhj*��ubj)��)}(h= { [0...10] = 5 }h]h= { [0...10] = 5 }}hj +��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhhj*��ubeh}(h]h ]h"]h$]h&]uh1jQ��hj*��ubeh}(h]h ]h"]h$]h&]j2��j3��j4��hj5��j6��uh1j��hj*��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj*��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhhj)��ubjP ��)}(h**CONCATENATED_STRING** Concatenated elements should have a space in between. Example:: printk(KERN_INFO"bar"); should be:: printk(KERN_INFO "bar"); h](jV ��)}(h**CONCATENATED_STRING**h]j\ ��)}(hj9+��h]hCONCATENATED_STRING}(hj;+��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj7+��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMrhj3+��ubjq ��)}(hhh](h)}(h?Concatenated elements should have a space in between. Example::h]h>Concatenated elements should have a space in between. Example:}(hjQ+��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMkhjN+��ubj)��)}(hprintk(KERN_INFO"bar");h]hprintk(KERN_INFO"bar");}hj_+��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMnhjN+��ubh)}(h should be::h]h should be:}(hjm+��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMphjN+��ubj)��)}(hprintk(KERN_INFO "bar");h]hprintk(KERN_INFO "bar");}hj{+��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMrhjN+��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj3+��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMrhj)��ubjP ��)}(h**ELSE_AFTER_BRACE** `else {` should follow the closing block `}` on the same line. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces h](jV ��)}(h**ELSE_AFTER_BRACE**h]j\ ��)}(hj+��h]hELSE_AFTER_BRACE}(hj+��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj+��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMwhj+��ubjq ��)}(hhh](h)}(h>`else {` should follow the closing block `}` on the same line.h](j��)}(h`else {`h]helse {}(hj+��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj+��ubh! should follow the closing block }(hj+��hhhNhNubj��)}(h`}`h]h}}(hj+��hhhNhNubah}(h]h ]h"]h$]h&]uh1j��hj+��ubh on the same line.}(hj+��hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMuhj+��ubh)}(h_See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh](hSee: }(hj+��hhhNhNubj ��)}(hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh]hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces}(hj+��hhhNhNubah}(h]h ]h"]h$]h&]refurij+��uh1j ��hj+��ubeh}(h]h ]h"]h$]h&]uh1hhhhMwhj+��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj+��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMwhj)��ubjP ��)}(h**LINE_SPACING** Vertical space is wasted given the limited number of lines an editor window can display when multiple blank lines are used. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces h](jV ��)}(h**LINE_SPACING**h]j\ ��)}(hj,��h]h LINE_SPACING}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj,��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM}hj ,��ubjq ��)}(hhh](h)}(h{Vertical space is wasted given the limited number of lines an editor window can display when multiple blank lines are used.h]h{Vertical space is wasted given the limited number of lines an editor window can display when multiple blank lines are used.}(hj(,��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMzhj%,��ubh)}(hLSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh](hSee: }(hj6,��hhhNhNubj ��)}(hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh]hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spaces}(hj>,��hhhNhNubah}(h]h ]h"]h$]h&]refurij@,��uh1j ��hj6,��ubeh}(h]h ]h"]h$]h&]uh1hhhhM}hj%,��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj ,��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM}hj)��ubjP ��)}(hX��**OPEN_BRACE** The opening brace should be following the function definitions on the next line. For any non-functional block it should be on the same line as the last construct. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces h](jV ��)}(h**OPEN_BRACE**h]j\ ��)}(hje,��h]h OPEN_BRACE}(hjg,��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjc,��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj_,��ubjq ��)}(hhh](h)}(hThe opening brace should be following the function definitions on the next line. For any non-functional block it should be on the same line as the last construct.h]hThe opening brace should be following the function definitions on the next line. For any non-functional block it should be on the same line as the last construct.}(hj},��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjz,��ubh)}(h_See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh](hSee: }(hj,��hhhNhNubj ��)}(hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh]hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]refurij,��uh1j ��hj,��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjz,��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj_,��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubjP ��)}(hX��**POINTER_LOCATION** When using pointer data or a function that returns a pointer type, the preferred use of * is adjacent to the data name or function name and not adjacent to the type name. Examples:: char *linux_banner; unsigned long long memparse(char *ptr, char **retptr); char *match_strdup(substring_t *s); See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces h](jV ��)}(h**POINTER_LOCATION**h]j\ ��)}(hj,��h]hPOINTER_LOCATION}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj,��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj,��ubjq ��)}(hhh](h)}(hWhen using pointer data or a function that returns a pointer type, the preferred use of * is adjacent to the data name or function name and not adjacent to the type name. Examples::h]hWhen using pointer data or a function that returns a pointer type, the preferred use of * is adjacent to the data name or function name and not adjacent to the type name. Examples:}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,��ubj)��)}(hnchar *linux_banner; unsigned long long memparse(char *ptr, char **retptr); char *match_strdup(substring_t *s);h]hnchar *linux_banner; unsigned long long memparse(char *ptr, char **retptr); char *match_strdup(substring_t *s);}hj,��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj,��ubh)}(hLSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh](hSee: }(hj,��hhhNhNubj ��)}(hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh]hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spaces}(hj,��hhhNhNubah}(h]h ]h"]h$]h&]refurij,��uh1j ��hj,��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj,��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj,��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubjP ��)}(h**SPACING** Whitespace style used in the kernel sources is described in kernel docs. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces h](jV ��)}(h **SPACING**h]j\ ��)}(hj-��h]hSPACING}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj-��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj-��ubjq ��)}(hhh](h)}(hHWhitespace style used in the kernel sources is described in kernel docs.h]hHWhitespace style used in the kernel sources is described in kernel docs.}(hj5-��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj2-��ubh)}(hLSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh](hSee: }(hjC-��hhhNhNubj ��)}(hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh]hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spaces}(hjK-��hhhNhNubah}(h]h ]h"]h$]h&]refurijM-��uh1j ��hjC-��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj2-��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj-��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubjP ��)}(h**TRAILING_WHITESPACE** Trailing whitespace should always be removed. Some editors highlight the trailing whitespace and cause visual distractions when editing files. See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces h](jV ��)}(h**TRAILING_WHITESPACE**h]j\ ��)}(hjr-��h]hTRAILING_WHITESPACE}(hjt-��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjp-��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjl-��ubjq ��)}(hhh](h)}(hTrailing whitespace should always be removed. Some editors highlight the trailing whitespace and cause visual distractions when editing files.h]hTrailing whitespace should always be removed. Some editors highlight the trailing whitespace and cause visual distractions when editing files.}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj-��ubh)}(hLSee: https://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh](hSee: }(hj-��hhhNhNubj ��)}(hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spacesh]hGhttps://www.kernel.org/doc/html/latest/process/coding-style.html#spaces}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]refurij-��uh1j ��hj-��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj-��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjl-��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubjP ��)}(hX��**UNNECESSARY_PARENTHESES** Parentheses are not required in the following cases: 1. Function pointer uses:: (foo->bar)(); could be:: foo->bar(); 2. Comparisons in if:: if ((foo->bar) && (foo->baz)) if ((foo == bar)) could be:: if (foo->bar && foo->baz) if (foo == bar) 3. addressof/dereference single Lvalues:: &(foo->bar) *(foo->bar) could be:: &foo->bar *foo->bar h](jV ��)}(h**UNNECESSARY_PARENTHESES**h]j\ ��)}(hj-��h]hUNNECESSARY_PARENTHESES}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj-��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj-��ubjq ��)}(hhh](h)}(h4Parentheses are not required in the following cases:h]h4Parentheses are not required in the following cases:}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj-��ubjG��)}(hXV��1. Function pointer uses:: (foo->bar)(); could be:: foo->bar(); 2. Comparisons in if:: if ((foo->bar) && (foo->baz)) if ((foo == bar)) could be:: if (foo->bar && foo->baz) if (foo == bar) 3. addressof/dereference single Lvalues:: &(foo->bar) *(foo->bar) could be:: &foo->bar *foo->bar h](j��)}(hhh]jR��)}(h(Function pointer uses:: (foo->bar)(); h](h)}(hFunction pointer uses::h]hFunction pointer uses:}(hj-��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj-��ubj)��)}(h (foo->bar)();h]h (foo->bar)();}hj.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj-��ubeh}(h]h ]h"]h$]h&]uh1jQ��hj-��ubah}(h]h ]h"]h$]h&]j2��j3��j4��hj5��j6��uh1j��hj-��ubjG��)}(hcould be:: foo->bar(); h](h)}(h could be::h]h could be:}(hj$.��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj .��ubj)��)}(h foo->bar();h]h foo->bar();}hj2.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj .��ubeh}(h]h ]h"]h$]h&]uh1jF��hhhMhj-��ubj��)}(hhh]jR��)}(hGComparisons in if:: if ((foo->bar) && (foo->baz)) if ((foo == bar)) h](h)}(hComparisons in if::h]hComparisons in if:}(hjM.��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjI.��ubj)��)}(h/if ((foo->bar) && (foo->baz)) if ((foo == bar))h]h/if ((foo->bar) && (foo->baz)) if ((foo == bar))}hj[.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjI.��ubeh}(h]h ]h"]h$]h&]uh1jQ��hjF.��ubah}(h]h ]h"]h$]h&]j2��j3��j4��hj5��j6��startKuh1j��hj-��ubjG��)}(h:could be:: if (foo->bar && foo->baz) if (foo == bar) h](h)}(h could be::h]h could be:}(hjz.��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjv.��ubj)��)}(h)if (foo->bar && foo->baz) if (foo == bar)h]h)if (foo->bar && foo->baz) if (foo == bar)}hj.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjv.��ubeh}(h]h ]h"]h$]h&]uh1jF��hhhMhj-��ubj��)}(hhh]jR��)}(hBaddressof/dereference single Lvalues:: &(foo->bar) *(foo->bar) h](h)}(h&addressof/dereference single Lvalues::h]h%addressof/dereference single Lvalues:}(hj.��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.��ubj)��)}(h&(foo->bar) *(foo->bar)h]h&(foo->bar) *(foo->bar)}hj.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj.��ubeh}(h]h ]h"]h$]h&]uh1jQ��hj.��ubah}(h]h ]h"]h$]h&]j2��j3��j4��hj5��j6��ju.��Kuh1j��hj-��ubjG��)}(h$could be:: &foo->bar *foo->bar h](h)}(h could be::h]h could be:}(hj.��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.��ubj)��)}(h&foo->bar *foo->barh]h&foo->bar *foo->bar}hj.��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj.��ubeh}(h]h ]h"]h$]h&]uh1jF��hhhMhj-��ubeh}(h]h ]h"]h$]h&]uh1jF��hhhMhj-��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj-��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubjP ��)}(h**WHILE_AFTER_BRACE** while should follow the closing bracket on the same line:: do { ... } while(something); See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces h](jV ��)}(h**WHILE_AFTER_BRACE**h]j\ ��)}(hj /��h]hWHILE_AFTER_BRACE}(hj /��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj/��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj/��ubjq ��)}(hhh](h)}(h:while should follow the closing bracket on the same line::h]h9while should follow the closing bracket on the same line:}(hj!/��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj/��ubj)��)}(h$do { ... } while(something);h]h$do { ... } while(something);}hj//��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhj/��ubh)}(h_See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh](hSee: }(hj=/��hhhNhNubj ��)}(hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spacesh]hZhttps://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces}(hjE/��hhhNhNubah}(h]h ]h"]h$]h&]refurijG/��uh1j ��hj=/��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj/��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj/��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj)��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj)��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMBhj)��hhubeh}(h]spacing-and-bracketsah ]h"]spacing and bracketsah$]h&]uh1hhj��hhhhhM@ubh)}(hhh](h)}(hOthersh]hOthers}(hj}/��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjz/��hhhhhMubjG��)}(hX' ��**CONFIG_DESCRIPTION** Kconfig symbols should have a help text which fully describes it. **CORRUPTED_PATCH** The patch seems to be corrupted or lines are wrapped. Please regenerate the patch file before sending it to the maintainer. **CVS_KEYWORD** Since linux moved to git, the CVS markers are no longer used. So, CVS style keywords ($Id$, $Revision$, $Log$) should not be added. **DEFAULT_NO_BREAK** switch default case is sometimes written as "default:;". This can cause new cases added below default to be defective. A "break;" should be added after empty default statement to avoid unwanted fallthrough. **DOS_LINE_ENDINGS** For DOS-formatted patches, there are extra ^M symbols at the end of the line. These should be removed. **DT_SCHEMA_BINDING_PATCH** DT bindings moved to a json-schema based format instead of freeform text. See: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html **DT_SPLIT_BINDING_PATCH** Devicetree bindings should be their own patch. This is because bindings are logically independent from a driver implementation, they have a different maintainer (even though they often are applied via the same tree), and it makes for a cleaner history in the DT only tree created with git-filter-branch. See: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters **EMBEDDED_FILENAME** Embedding the complete filename path inside the file isn't particularly useful as often the path is moved around and becomes incorrect. **FILE_PATH_CHANGES** Whenever files are added, moved, or deleted, the MAINTAINERS file patterns can be out of sync or outdated. So MAINTAINERS might need updating in these cases. **MEMSET** The memset use appears to be incorrect. This may be caused due to badly ordered parameters. Please recheck the usage. **NOT_UNIFIED_DIFF** The patch file does not appear to be in unified-diff format. Please regenerate the patch file before sending it to the maintainer. **PLACEHOLDER_USE** Detects unhandled placeholder text left in cover letters or commit headers/logs. Common placeholders include lines like:: *** SUBJECT HERE *** *** BLURB HERE *** These typically come from autogenerated templates. Replace them with a proper subject and description before sending. **PRINTF_0XDECIMAL** Prefixing 0x with decimal output is defective and should be corrected. **SPDX_LICENSE_TAG** The source file is missing or has an improper SPDX identifier tag. The Linux kernel requires the precise SPDX identifier in all source files, and it is thoroughly documented in the kernel docs. See: https://www.kernel.org/doc/html/latest/process/license-rules.html **TYPO_SPELLING** Some words may have been misspelled. Consider reviewing them.h]jK ��)}(hhh](jP ��)}(hY**CONFIG_DESCRIPTION** Kconfig symbols should have a help text which fully describes it. h](jV ��)}(h**CONFIG_DESCRIPTION**h]j\ ��)}(hj/��h]hCONFIG_DESCRIPTION}(hj/��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj/��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj/��ubjq ��)}(hhh]h)}(hAKconfig symbols should have a help text which fully describes it.h]hAKconfig symbols should have a help text which fully describes it.}(hj/��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj/��ubah}(h]h ]h"]h$]h&]uh1jp ��hj/��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**CORRUPTED_PATCH** The patch seems to be corrupted or lines are wrapped. Please regenerate the patch file before sending it to the maintainer. h](jV ��)}(h**CORRUPTED_PATCH**h]j\ ��)}(hj/��h]hCORRUPTED_PATCH}(hj/��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj/��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj/��ubjq ��)}(hhh]h)}(h{The patch seems to be corrupted or lines are wrapped. Please regenerate the patch file before sending it to the maintainer.h]h{The patch seems to be corrupted or lines are wrapped. Please regenerate the patch file before sending it to the maintainer.}(hj/��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj/��ubah}(h]h ]h"]h$]h&]uh1jp ��hj/��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**CVS_KEYWORD** Since linux moved to git, the CVS markers are no longer used. So, CVS style keywords ($Id$, $Revision$, $Log$) should not be added. h](jV ��)}(h**CVS_KEYWORD**h]j\ ��)}(hj0��h]h CVS_KEYWORD}(hj 0��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj0��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj0��ubjq ��)}(hhh]h)}(hSince linux moved to git, the CVS markers are no longer used. So, CVS style keywords ($Id$, $Revision$, $Log$) should not be added.h]hSince linux moved to git, the CVS markers are no longer used. So, CVS style keywords ($Id$, $Revision$, $Log$) should not be added.}(hj 0��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0��ubah}(h]h ]h"]h$]h&]uh1jp ��hj0��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**DEFAULT_NO_BREAK** switch default case is sometimes written as "default:;". This can cause new cases added below default to be defective. A "break;" should be added after empty default statement to avoid unwanted fallthrough. h](jV ��)}(h**DEFAULT_NO_BREAK**h]j\ ��)}(hj@0��h]hDEFAULT_NO_BREAK}(hjB0��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj>0��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj:0��ubjq ��)}(hhh](h)}(hwswitch default case is sometimes written as "default:;". This can cause new cases added below default to be defective.h]h{switch default case is sometimes written as “default:;”. This can cause new cases added below default to be defective.}(hjX0��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjU0��ubh)}(hWA "break;" should be added after empty default statement to avoid unwanted fallthrough.h]h[A “break;” should be added after empty default statement to avoid unwanted fallthrough.}(hjf0��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjU0��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj:0��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h}**DOS_LINE_ENDINGS** For DOS-formatted patches, there are extra ^M symbols at the end of the line. These should be removed. h](jV ��)}(h**DOS_LINE_ENDINGS**h]j\ ��)}(hj0��h]hDOS_LINE_ENDINGS}(hj0��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj0��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj0��ubjq ��)}(hhh]h)}(hgFor DOS-formatted patches, there are extra ^M symbols at the end of the line. These should be removed.h]hgFor DOS-formatted patches, there are extra ^M symbols at the end of the line. These should be removed.}(hj0��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0��ubah}(h]h ]h"]h$]h&]uh1jp ��hj0��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**DT_SCHEMA_BINDING_PATCH** DT bindings moved to a json-schema based format instead of freeform text. See: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html h](jV ��)}(h**DT_SCHEMA_BINDING_PATCH**h]j\ ��)}(hj0��h]hDT_SCHEMA_BINDING_PATCH}(hj0��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj0��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj0��ubjq ��)}(hhh](h)}(hIDT bindings moved to a json-schema based format instead of freeform text.h]hIDT bindings moved to a json-schema based format instead of freeform text.}(hj0��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0��ubh)}(hSSee: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.htmlh](hSee: }(hj0��hhhNhNubj ��)}(hNhttps://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.htmlh]hNhttps://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html}(hj0��hhhNhNubah}(h]h ]h"]h$]h&]refurij0��uh1j ��hj0��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj0��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj0��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(hX��**DT_SPLIT_BINDING_PATCH** Devicetree bindings should be their own patch. This is because bindings are logically independent from a driver implementation, they have a different maintainer (even though they often are applied via the same tree), and it makes for a cleaner history in the DT only tree created with git-filter-branch. See: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters h](jV ��)}(h**DT_SPLIT_BINDING_PATCH**h]j\ ��)}(hj1��h]hDT_SPLIT_BINDING_PATCH}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj1��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj 1��ubjq ��)}(hhh](h)}(hX0��Devicetree bindings should be their own patch. This is because bindings are logically independent from a driver implementation, they have a different maintainer (even though they often are applied via the same tree), and it makes for a cleaner history in the DT only tree created with git-filter-branch.h]hX0��Devicetree bindings should be their own patch. This is because bindings are logically independent from a driver implementation, they have a different maintainer (even though they often are applied via the same tree), and it makes for a cleaner history in the DT only tree created with git-filter-branch.}(hj+1��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(1��ubh)}(hnSee: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submittersh](hSee: }(hj91��hhhNhNubj ��)}(hihttps://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submittersh]hihttps://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters}(hjA1��hhhNhNubah}(h]h ]h"]h$]h&]refurijC1��uh1j ��hj91��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj(1��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj 1��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**EMBEDDED_FILENAME** Embedding the complete filename path inside the file isn't particularly useful as often the path is moved around and becomes incorrect. h](jV ��)}(h**EMBEDDED_FILENAME**h]j\ ��)}(hjh1��h]hEMBEDDED_FILENAME}(hjj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjf1��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhjb1��ubjq ��)}(hhh]h)}(hEmbedding the complete filename path inside the file isn't particularly useful as often the path is moved around and becomes incorrect.h]hEmbedding the complete filename path inside the file isn’t particularly useful as often the path is moved around and becomes incorrect.}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj}1��ubah}(h]h ]h"]h$]h&]uh1jp ��hjb1��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**FILE_PATH_CHANGES** Whenever files are added, moved, or deleted, the MAINTAINERS file patterns can be out of sync or outdated. So MAINTAINERS might need updating in these cases. h](jV ��)}(h**FILE_PATH_CHANGES**h]j\ ��)}(hj1��h]hFILE_PATH_CHANGES}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj1��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj1��ubjq ��)}(hhh](h)}(hjWhenever files are added, moved, or deleted, the MAINTAINERS file patterns can be out of sync or outdated.h]hjWhenever files are added, moved, or deleted, the MAINTAINERS file patterns can be out of sync or outdated.}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1��ubh)}(h2So MAINTAINERS might need updating in these cases.h]h2So MAINTAINERS might need updating in these cases.}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj1��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**MEMSET** The memset use appears to be incorrect. This may be caused due to badly ordered parameters. Please recheck the usage. h](jV ��)}(h **MEMSET**h]j\ ��)}(hj1��h]hMEMSET}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj1��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj1��ubjq ��)}(hhh]h)}(hwThe memset use appears to be incorrect. This may be caused due to badly ordered parameters. Please recheck the usage.h]hwThe memset use appears to be incorrect. This may be caused due to badly ordered parameters. Please recheck the usage.}(hj1��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1��ubah}(h]h ]h"]h$]h&]uh1jp ��hj1��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(h**NOT_UNIFIED_DIFF** The patch file does not appear to be in unified-diff format. Please regenerate the patch file before sending it to the maintainer. h](jV ��)}(h**NOT_UNIFIED_DIFF**h]j\ ��)}(hj2��h]hNOT_UNIFIED_DIFF}(hj 2��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj2��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj2��ubjq ��)}(hhh]h)}(hThe patch file does not appear to be in unified-diff format. Please regenerate the patch file before sending it to the maintainer.h]hThe patch file does not appear to be in unified-diff format. Please regenerate the patch file before sending it to the maintainer.}(hj62��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM�hj32��ubah}(h]h ]h"]h$]h&]uh1jp ��hj2��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(hX2��**PLACEHOLDER_USE** Detects unhandled placeholder text left in cover letters or commit headers/logs. Common placeholders include lines like:: *** SUBJECT HERE *** *** BLURB HERE *** These typically come from autogenerated templates. Replace them with a proper subject and description before sending. h](jV ��)}(h**PLACEHOLDER_USE**h]j\ ��)}(hjV2��h]hPLACEHOLDER_USE}(hjX2��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hjT2��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhM hjP2��ubjq ��)}(hhh](h)}(hyDetects unhandled placeholder text left in cover letters or commit headers/logs. Common placeholders include lines like::h]hxDetects unhandled placeholder text left in cover letters or commit headers/logs. Common placeholders include lines like:}(hjn2��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjk2��ubj)��)}(h'*** SUBJECT HERE *** *** BLURB HERE ***h]h'*** SUBJECT HERE *** *** BLURB HERE ***}hj|2��sbah}(h]h ]h"]h$]h&]hhuh1j(��hhhMhjk2��ubh)}(huThese typically come from autogenerated templates. Replace them with a proper subject and description before sending.h]huThese typically come from autogenerated templates. Replace them with a proper subject and description before sending.}(hj2��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjk2��ubeh}(h]h ]h"]h$]h&]uh1jp ��hjP2��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhM hj/��ubjP ��)}(h\**PRINTF_0XDECIMAL** Prefixing 0x with decimal output is defective and should be corrected. h](jV ��)}(h**PRINTF_0XDECIMAL**h]j\ ��)}(hj2��h]hPRINTF_0XDECIMAL}(hj2��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj2��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj2��ubjq ��)}(hhh]h)}(hFPrefixing 0x with decimal output is defective and should be corrected.h]hFPrefixing 0x with decimal output is defective and should be corrected.}(hj2��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj2��ubah}(h]h ]h"]h$]h&]uh1jp ��hj2��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(hX��**SPDX_LICENSE_TAG** The source file is missing or has an improper SPDX identifier tag. The Linux kernel requires the precise SPDX identifier in all source files, and it is thoroughly documented in the kernel docs. See: https://www.kernel.org/doc/html/latest/process/license-rules.html h](jV ��)}(h**SPDX_LICENSE_TAG**h]j\ ��)}(hj2��h]hSPDX_LICENSE_TAG}(hj2��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj2��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj2��ubjq ��)}(hhh](h)}(hThe source file is missing or has an improper SPDX identifier tag. The Linux kernel requires the precise SPDX identifier in all source files, and it is thoroughly documented in the kernel docs.h]hThe source file is missing or has an improper SPDX identifier tag. The Linux kernel requires the precise SPDX identifier in all source files, and it is thoroughly documented in the kernel docs.}(hj2��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj2��ubh)}(hFSee: https://www.kernel.org/doc/html/latest/process/license-rules.htmlh](hSee: }(hj3��hhhNhNubj ��)}(hAhttps://www.kernel.org/doc/html/latest/process/license-rules.htmlh]hAhttps://www.kernel.org/doc/html/latest/process/license-rules.html}(hj3��hhhNhNubah}(h]h ]h"]h$]h&]refurij3��uh1j ��hj3��ubeh}(h]h ]h"]h$]h&]uh1hhhhMhj2��ubeh}(h]h ]h"]h$]h&]uh1jp ��hj2��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubjP ��)}(hP**TYPO_SPELLING** Some words may have been misspelled. Consider reviewing them.h](jV ��)}(h**TYPO_SPELLING**h]j\ ��)}(hj73��h]h TYPO_SPELLING}(hj93��hhhNhNubah}(h]h ]h"]h$]h&]uh1j[ ��hj53��ubah}(h]h ]h"]h$]h&]uh1jU ��hhhMhj13��ubjq ��)}(hhh]h)}(h>Some words may have been misspelled. Consider reviewing them.h]h>Some words may have been misspelled. Consider reviewing them.}(hjO3��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjL3��ubah}(h]h ]h"]h$]h&]uh1jp ��hj13��ubeh}(h]h ]h"]h$]h&]uh1jO ��hhhMhj/��ubeh}(h]h ]h"]h$]h&]uh1jJ ��hj/��ubah}(h]h ]h"]h$]h&]uh1jF��hhhMhjz/��hhubeh}(h]othersah ]h"]othersah$]h&]uh1hhj��hhhhhMubeh}(h]type-descriptionsah ]h"]type descriptionsah$]h&]uh1hhhhhhhhKubeh}(h] checkpatchah ]h"] checkpatchah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj3��error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j3��j3��j��j��jK��jH��j��j��j3��j3��j ��j ��j��j��j��j��j/��j,��j��j��j��j��j#��j#��j(��j(��j)��j)��jw/��jt/��jz3��jw3��u nametypes}(j3��j��jK��j��j3��j ��j��j��j/��j��j��j#��j(��j)��jw/��jz3��uh}(j3��hj��hjH��j��j��jN��j3��j��j ��j5 ��j��j ��j��j��j,��j��j��j2��j��j��j#��j��j(��j#��j)��j(��jt/��j)��jw3��jz/��u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK� id_counter collectionsCounter}Rparse_messages](hsystem_message)}(hhh]h)}(h:Enumerated list start value not ordinal-1: "2" (ordinal 2)h]h>Enumerated list start value not ordinal-1: “2” (ordinal 2)}(hj4��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4��ubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehnjlineKuh1j4��hj-��ubj4��)}(hhh]h)}(h:Enumerated list start value not ordinal-1: "3" (ordinal 3)h]h>Enumerated list start value not ordinal-1: “3” (ordinal 3)}(hj34��hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj04��ubah}(h]h ]h"]h$]h&]levelKtypej-4��sourcehnjlineKuh1j4��hj-��ubetransform_messages] transformerN include_log] decorationNhhub.