Re: [PATCH resend] hsi: fix kernel-doc warnings

From: Linus Walleij
Date: Sun Mar 03 2013 - 21:56:12 EST


On Fri, Mar 1, 2013 at 8:11 PM, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Fix kernel-doc warnings in hsi files:
>
> Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'e_handler' description in 'hsi_client'
> Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'pclaimed' description in 'hsi_client'
> Warning(include/linux/hsi/hsi.h:136): Excess struct/union/enum/typedef member 'nb' description in 'hsi_client'
> Warning(drivers/hsi/hsi.c:434): No description found for parameter 'handler'
> Warning(drivers/hsi/hsi.c:434): Excess function parameter 'cb' description in 'hsi_register_port_event'
>
> Don't document "private:" fields with kernel-doc notation.
> If you want to leave them fully documented, that's OK, but
> then don't mark them as "private:".
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Carlos Chinea <carlos.chinea@xxxxxxxxx>
> Cc: Linus Walleij <linus.walleij@xxxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Cc: linux-omap@xxxxxxxxxxxxxxx
> Acked-by: Nishanth Menon <nm@xxxxxx>

Acked-by: Linus Walleij <linus.walleij@xxxxxxxxxx>

HSI is basically orphaned FTM.

Andrew can you pick this into your orphanage?

Yours,
Linus Walleij
--
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/