Re: [OPW kernel] checkpatch: Does anyone care that comments are freeform aligned?

From: Joe Perches
Date: Sat Sep 27 2014 - 00:59:19 EST


On Fri, 2014-09-26 at 16:03 -0700, josh@xxxxxxxxxxxxxxxx wrote:
> On Wed, Sep 24, 2014 at 11:41:14AM -0700, Joe Perches wrote:
> > On Wed, 2014-09-24 at 07:47 +0200, Julia Lawall wrote:
> > > In the following patch extract, one line is indented with spaces rather
> > > than tabs. Is it intentional that checkpatch doesn't complain about this,
> > > I guess due to the line being a comment?
> > []
> > > struct bcm_hdr_suppression_contextinfo {
> > > - UCHAR ucaHdrSuppressionInBuf[MAX_PHS_LENGTHS]; /* Intermediate buffer to accumulate pkt Header for PHS */
> > > - UCHAR ucaHdrSuppressionOutBuf[MAX_PHS_LENGTHS + PHSI_LEN]; /* Intermediate buffer containing pkt Header after PHS */
> > > + /* Intermediate buffer to accumulate pkt Header for PHS */
> > > + UCHAR ucaHdrSuppressionInBuf[MAX_PHS_LENGTHS];
> > > + /* Intermediate buffer containing pkt Header after PHS */
> > > + UCHAR ucaHdrSuppressionOutBuf[MAX_PHS_LENGTHS + PHSI_LEN];
> > > };
> >
> > checkpatch does not care when comments start in any
> > particular position or ensure comments have tabs
> > preceding them.
> >
> > Does anyone care?
>
> This should have already been caught by other whitespace checks that
> check for indentations of 8 or more spaces. Similarly, mixed tab/space
> indentations would get caught by those same checks.

Yes and no.

Leading whitespace over 8 chars would (ie: "^ {8,}" is a warning)
but a statement like:

int foo; /* some comment */
[tab] [20 spaces] [tab]

would not.

> I don't think checkpatch needs to check those.

For the most part, I agree.

On Fri, 2014-09-26 at 16:06 -0700, josh@xxxxxxxxxxxxxxxx wrote:
> Lines starting with at least 8 spaces before a comment:
> $ git grep -E '^ {8,}/\*' | wc -l
> 1544
>
> I think just about all of those are bugs.

Maybe.

Most of those are from Linus' first git commit.


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