RE: [PATCH 1/6] bfa: Brocade BFA FC SCSI driver submission (2ndtry)

[Jing Huang]

Hi Greg, 

Those comments are used by doxygen. We use doxygen to generate
documentation in my company. So I guess this contradicts to linux
kerneldoc. I will look into this.

Yes, the scsi_xx.h file after local one seems strange, I will fix it.

Thanks

Jing





-----Original Message-----
From: Greg KH [mailto:greg@xxxxxxxxx] 
Sent: Thursday, September 25, 2008 7:53 PM
To: Jing Huang
Cc: James.Bottomley@xxxxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx;
linux-scsi@xxxxxxxxxxxxxxx; Ramkumar Vadivelu; Srikanth Rayas (CW);
Vinodh Ravindran
Subject: Re: [PATCH 1/6] bfa: Brocade BFA FC SCSI driver submission
(2ndtry)

On Thu, Sep 25, 2008 at 05:54:47PM -0700, Jing Huang wrote:
> +/**
> + * @file bfa_attr.c Linux driver configuration interface module.
> + */

What is this, kerneldoc isn't like this, right?

> +#include "bfad_drv.h"
> +#include "bfad_im.h"
> +#include "bfad_trcmod.h"
> +#include <scsi/scsi_transport.h>
> +#include "bfad_attr.h"

Why a scsi .h file after your local ones?

> +
> +/**
> + * @dg FC_transport_template FC transport template
> + * @{
> + */

What is this?

> +/**
> + * @brief
> + * FC transport template entry, get SCSI target port ID.
> + */

Same here, this looks very wierd.  This goes for all of your function
comments :(

thanks,

greg k-h
--
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/