linux-kernel - Re: [PATCH] checkpatch: Improve CamelCase test for Page

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAKocOONj+gEcBXZJXGqoY00mcUf5WpLo7j7JF-S20UZED+pLCA@mail.gmail.com>
Date:	Fri, 22 Feb 2013 15:57:16 -0700
From:	Shuah Khan <shuahkhan@...il.com>
To:	Joe Perches <joe@...ches.com>
Cc:	Peter Hurley <peter@...leysoftware.com>, akpm@...ux-foundation.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] checkpatch: Improve CamelCase test for Page

On Fri, Feb 22, 2013 at 3:21 PM, Joe Perches <joe@...ches.com> wrote:
> On Fri, 2013-02-22 at 17:01 -0500, Peter Hurley wrote:
>> I didn't bother to mention it before, but since your addressing mm
>> CamelCase exceptions, perhaps
>>
>>   xxxx_XXXX
>>   xx_XXX_xxx
>>   XXX_xxx
>>
>> could be exceptions as well?
>
> Maybe the check should only be for "[A-Z][a-z]|[a-z][A-Z]"
> to make '_' and any non-alpha char a name barrier.
>
> So vars like A_foo or b_9A would be acceptable.
>
> Maybe:
>
> ---
>  scripts/checkpatch.pl | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 747bcd7..e08e9f6 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -2929,8 +2929,8 @@ sub process {
>                 while ($line =~ m{($Constant|$Lval)}g) {
>                         my $var = $1;
>                         if ($var !~ /$Constant/ &&
> -                           $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
> -                           $var !~ /^Page[A-Z]/ &&
> +                           $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
> +                           $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && &&
>                             !defined $camelcase{$var}) {
>                                 $camelcase{$var} = 1;
>                                 WARN("CAMELCASE",
>
>

What are the guidelines on camelcase warnings on patches. A recent one
I ran into is on a variable in a structure and fixing it would require
changing the original variable.

WARNING: Avoid CamelCase: <cp->Header.SGList>
#67: FILE: drivers/scsi/hpsa.c:1409:
+		cp->Header.SGList = 0;

WARNING: Avoid CamelCase: <cp->Header.SGTotal>
#68: FILE: drivers/scsi/hpsa.c:1410:
+		cp->Header.SGTotal = 0;

total: 0 errors, 2 warnings, 11 lines checked

One would have to change a large portion of the code to fix it. In
such cases, do we ignore this warning?

-- Shuah
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/