linux-kernel - Re: [PATCH] Staging: dt3155: fix coding style issues in dt3155

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: <20100707004841.GA28188@verge.net.au>
Date:	Wed, 7 Jul 2010 09:48:42 +0900
From:	Simon Horman <horms@...ge.net.au>
To:	Aldo Cedillo <aldobrett11@...il.com>
Cc:	kagen101@...il.com, Greg Kroah-Hartman <gregkh@...e.de>,
	H Hartley Sweeten <hsweeten@...ionengravers.com>,
	devel <devel@...verdev.osuosl.org>,
	linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] Staging: dt3155: fix coding style issues in
 dt3155_drv.c

On Tue, Jul 06, 2010 at 12:25:35PM -0500, Aldo Cedillo wrote:
> > diff --git a/drivers/staging/dt3155/dt3155_drv.c b/drivers/staging/dt3155/dt3155_drv.c
> > index 66db878..f6edd66 100644
> > --- a/drivers/staging/dt3155/dt3155_drv.c
> > +++ b/drivers/staging/dt3155/dt3155_drv.c
> > @@ -308,33 +308,42 @@ static void dt3155_isr(int irq, void *dev_id, struct pt_regs *regs)
> >  #endif
> >                        if (fb->nbuffers > 2) {
> >                                if (!are_empty_buffers(minor)) {
> > -                                       /* The number of active + locked buffers is
> > -                                        * at most 2, and since there are none empty, there
> > -                                        * must be at least nbuffers-2 ready buffers.
> > -                                        * This is where we 'drop frames', oldest first. */
> > +                                       /* The number of active +
> > +                                        * locked buffers is at most 2,
> > +                                        * and since there are none empty,
> > +                                        * there must be at least nbuffers-2
> > +                                        * ready buffers.
> > +                                        * This is where we 'drop frames',
> > +                                        * oldest first. */
> >                                        push_empty(pop_ready(minor),  minor);
> >                                }
> >
> 
> In the CodingStyle in the kernel you can read:
> 
> The preferred style for long (multi-line) comments is:
> 
>         /*
>          * This is the preferred style for multi-line
>          * comments in the Linux kernel source code.
>          * Please use it consistently.
>          *
>          * Description:  A column of asterisks on the left side,
>          * with beginning and ending almost-blank lines.
>          */
> 
> Again I ask about the coding style because I have seen in many parts of the
> kernel I've seen discrepancies with what is said in the CodingStyle file. So
> I want to get it clear maybe I can help to clean those things.

I believe that you will find both of the following styles in abundance
and that both are acceptable.

   /*
    * This
    * is a multi-line comment
    */

And

   /* This
    * is a also multi-line comment
    */

Though one may be more acceptable to a given maintainer than the other.
Other variants may also be common and acceptable to some maintainers,
which I suspect is why checkpatch.pl is lenient.

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