Re: [PATCH 1/2] Support for the at91sam9g20 : Atmel 400Mhz ARM 926ej-s SOC

[Russell King - ARM Linux]

On Thu, Jul 03, 2008 at 04:19:17PM +0200, Sedji Gaouaou wrote:
> Hi Andrew,
> >   
> >> +/*
> >> + * MCI (SD/MMC)
> >> + */
> >> +static struct at91_mmc_data __initdata ek_mmc_data = {
> >> +	.slot_b		= 1,
> >> +	.wire4		= 1,
> >> +//	.det_pin	= ... not connected
> >> +//	.wp_pin		= ... not connected
> >> +//	.vcc_pin	= ... not connected
> >>     
> >
> > Please make these a proper comment, preferably inside the comment before
> > the structure.  C++ comments are frowned upon in the kernel's source.
>
>
> I would like to know what do you suggest about this comment? Indeed we 
> already use this kind of comments, for instance in board-sam9260ek.c. I 
> don't mind changing it into the proper comment form, but I would like to 
> know first what do you suggest.

Documentation/CodingStyle:
|
|                Chapter 8: Commenting
|
...
|
|Linux style for comments is the C89 "/* ... */" style.
|Don't use C99-style "// ..." comments.

So how about:

/*
 * MCI (SD/MMC)
 * det_pin, wp_pin and vcc_pin are not connected
 */
static struct at91_mmc_data __initdata ek_mmc_data = {
	.slot_b         = 1,
	.wire4          = 1,
};
--
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/