[PATCH v4] Documentation: checkpatch: Add SYMBOLIC_PERMS message

Dwaipayan Ray dwaipayanray1 at gmail.com
Sun Aug 22 17:52:08 UTC 2021


On Sat, Aug 7, 2021 at 1:41 AM Utkarsh Verma <utkarshverma294 at gmail.com> wrote:
>
> Add a new message type SYMBOLIC_PERMS under the 'Permissions'
> subsection. Users should use octal permission bits instead of their
> symbolic macro names.
>

Like Lukas said, the reader could use a better explanation as to why octal
permission bits are preferred.

However, I think this message shall be fine too as it's pretty much
self-explanatory.

So, with that:

Reviewed-by: Dwaipayan Ray <dwaipayanray1 at gmail.com>

> Suggested-by: Lukas Bulwahn <lukas.bulwahn at gmail.com>
> Signed-off-by: Utkarsh Verma <utkarshverma294 at gmail.com>
> ---
>  Documentation/dev-tools/checkpatch.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index f0956e9ea..009957cda 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -957,6 +957,12 @@ 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.
> +
> +    See: https://lore.kernel.org/lkml/CA+55aFw5v23T-zvDZp-MmD_EYxF8WbafwwB59934FV7g21uMGQ@mail.gmail.com/
> +
>
>  Spacing and Brackets
>  --------------------
> --
> 2.17.1
>


More information about the Linux-kernel-mentees mailing list