linux-kernel - Re: [PATCH] Documentation/CodingStyle: Add an example for braces

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: <2c16cde9-6f20-e49e-f2ad-db2984fd910f@amd.com>
Date:   Thu, 15 Mar 2018 14:54:26 -0500
From:   Gary R Hook <gary.hook@....com>
To:     Jani Nikula <jani.nikula@...ux.intel.com>,
        linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, corbet@....net
Subject: Re: [PATCH] Documentation/CodingStyle: Add an example for braces

On 03/15/2018 05:26 AM, Jani Nikula wrote:
> On Wed, 14 Mar 2018, Gary R Hook <gary.hook@....com> wrote:
>> Add another example of required braces when using a compound statement in
>> a loop.
>>
>> Signed-off-by: Gary R Hook <gary.hook@....com>
>> ---
>>   Documentation/process/coding-style.rst |    9 +++++++++
>>   1 file changed, 9 insertions(+)
>>
>> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
>> index a20b44a40ec4..d98deb62c400 100644
>> --- a/Documentation/process/coding-style.rst
>> +++ b/Documentation/process/coding-style.rst
>> @@ -200,6 +200,15 @@ statement; in the latter case use braces in both branches:
>>   		otherwise();
>>   	}
>>   
>> +Also, use braces when a loop contains more than a single simple statement:
> 
> Personally, I'd not limit this to loops.
> 
> 	if (condition) {
>          	if (another_condition)
>                  	action();
>          }
> 
> You could argue the existing rule already covers these cases by
> excluding selection and iteration statements from the "single statement"
> in "Do not unnecessarily use braces where a single statement will do."

Define "statement"? There's a school of thought that uses semicolons to 
indicate a statement. I'm trying to eliminate any ambiguity by calling 
out compound statements as "more than one statement". Sure, semantics,
but in the interest of clarity. An additional sentence and example 
doesn't really cost much.

Thank you for your time. I've made some changes, and a v2 to follow shortly.