linux-kernel - Re: Checkpatch error on trace events macros

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: <20130729212328.GD14883@xanatos>
Date:	Mon, 29 Jul 2013 14:23:28 -0700
From:	Sarah Sharp <sarah.a.sharp@...ux.intel.com>
To:	Joe Perches <joe@...ches.com>
Cc:	Andy Whitcroft <apw@...onical.com>, linux-kernel@...r.kernel.org
Subject: Re: Checkpatch error on trace events macros

On Mon, Jul 29, 2013 at 01:02:44PM -0700, Joe Perches wrote:
> On Mon, 2013-07-29 at 12:52 -0700, Sarah Sharp wrote:
> > Hi Andy and Joe,
> 
> Hi Sarah.
> 
> > Checkpatch is complaining when code adds new trace events macros:
> > 
> > sarah@...atos:~/git/kernels/xhci$ git am -s ~/Maildir.fetchmail/.to-apply
> > Applying: xhci: add traces for debug messages in xhci_address_device()
> > ERROR: Macros with complex values should be enclosed in parenthesis
> > #86: FILE: drivers/usb/host/xhci-trace.h:15:
> > +#define TRACE_SYSTEM xhci-hcd
> 
> <shrug>
> 
> I think these are suboptimal as the files should use
> underscores rather than dashes.

The norm in the USB subsystem is to use dashes in filenames.  I think
it's suboptimal to have to use the shift key at all when typing
filenames.  We have different preferences here, and different reasons
for those preferences, but there is no "should" here, just opinions.

> checkpatch sees this as a subtraction which really
> should have parentheses.

I see.

> > ERROR: Macros with complex values should be enclosed in parenthesis
> > #115: FILE: drivers/usb/host/xhci-trace.h:44:
> > +#define TRACE_INCLUDE_PATH .
> > 
> > ERROR: Macros with complex values should be enclosed in parenthesis
> > #118: FILE: drivers/usb/host/xhci-trace.h:47:
> > +#define TRACE_INCLUDE_FILE xhci-trace
> 
> Don't expect to checkpatch to be perfect.
> 
> It's not.
> 
> It's a stupid little tool good for some things
> and good for highlighting areas that might need
> another look.
> 
> Use your judgment about everything it spews.

If checkpatch spews warnings and errors,  that makes it basically
useless as a git pre-commit hook.

Sigh, I suppose I'll just add a '|| true' to the end of the line and
deal with it.

Sarah Sharp
--
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/