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

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]

Date:	Mon, 4 Mar 2013 03:56:04 +0100
From:	Linus Walleij <linus.walleij@...aro.org>
To:	Randy Dunlap <rdunlap@...radead.org>,
	Andrew Morton <akpm@...ux-foundation.org>
Cc:	LKML <linux-kernel@...r.kernel.org>,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
	Linus Torvalds <torvalds@...ux-foundation.org>,
	Nishanth Menon <nm@...com>,
	Carlos Chinea <carlos.chinea@...ia.com>,
	linux-omap@...r.kernel.org
Subject: Re: [PATCH resend] hsi: fix kernel-doc warnings

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

> From: Randy Dunlap <rdunlap@...radead.org>
>
> 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@...radead.org>
> Cc: Carlos Chinea <carlos.chinea@...ia.com>
> Cc: Linus Walleij <linus.walleij@...aro.org>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: linux-kernel@...r.kernel.org
> Cc: linux-omap@...r.kernel.org
> Acked-by: Nishanth Menon <nm@...com>

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

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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/