linux-kernel - Re: [PATCH] Documentation: Fixed errors in the title level of coding style documents

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <8735elclp1.fsf@meer.lwn.net>
Date:   Thu, 28 Jul 2022 09:15:54 -0600
From:   Jonathan Corbet <corbet@....net>
To:     fslongjin <longjin@...GoTek.cn>, twoerner@...il.com,
        keescook@...omium.org
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        fslongjin <fslongjin@....qq.com>, longjin <longjin@...GoTek.cn>
Subject: Re: [PATCH] Documentation: Fixed errors in the title level of
 coding style documents

fslongjin <longjin@...GoTek.cn> writes:

> From: fslongjin <fslongjin@....qq.com>
>
> In Section 3, `Placing Braces and Spaces`. In the previous document, only
> `Spaces` is written in the subtitle without the `Braces`. I think this
>  may be a format error caused by negligence, so I fixed it.
>
> Signed-off-by: longjin <longjin@...GoTek.cn>
> Signed-off-by: fslongjin <fslongjin@....qq.com>

I don't understand this signoff chain; did both of you work on this
small patch?

Signoffs should also have full legal names in them.

> ---
>  Documentation/process/coding-style.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 03eb53fd029a..2a26bcb9f391 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -120,6 +120,9 @@ that breaks the ability to grep for them.
>  3) Placing Braces and Spaces
>  ----------------------------
>  
> +3.1) Braces
> +***********
> +
>  The other issue that always comes up in C styling is the placement of
>  braces.  Unlike the indent size, there are few technical reasons to
>  choose one placement strategy over the other, but the preferred way, as
> @@ -231,7 +234,7 @@ Also, use braces when a loop contains more than a single simple statement:
>  			do_something();
>  	}
>  
> -3.1) Spaces
> +3.2) Spaces
>  ***********

This seems like a fine change but, as you notice here, putting section
numbers into the text leads to ongoing update problems.  Sphinx can add
those nicely, so I generally suggest just removing them entirely.  I
wouldn't insist on that, but if you felt so inclined, that would be a
good improvement to the patch.

Thanks,

jon