linux-kernel - Re: [PATCH] HSI: Remove struct hsi_client private fields from kernel-doc

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20151113220628.GA24590@earth>
Date:	Fri, 13 Nov 2015 23:06:29 +0100
From:	Sebastian Reichel <sre@...nel.org>
To:	Javier Martinez Canillas <javier@....samsung.com>
Cc:	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] HSI: Remove struct hsi_client private fields from
 kernel-doc

On Fri, Nov 13, 2015 at 02:08:22PM -0300, Javier Martinez Canillas wrote:
> Hello Sebastian,
> 
> On 10/08/2015 04:11 AM, Javier Martinez Canillas wrote:
> > The kernel-doc how to says that structure fields that are inside a
> > "private:" area shouldn't be listed in the generated documentation
> > but the private fields for struct hsi_client private are listed.
> > 
> > This also fixes the following make htmldocs warnings:
> > 
> > .//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'e_handler' description in 'hsi_client'
> > .//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'pclaimed' description in 'hsi_client'
> > .//include/linux/hsi/hsi.h:150: warning: Excess struct/union/enum/typedef member 'nb' description in 'hsi_client'
> > 
> > Signed-off-by: Javier Martinez Canillas <javier@....samsung.com>
> > 
> > ---
> > 
> >  include/linux/hsi/hsi.h | 3 ---
> >  1 file changed, 3 deletions(-)
> > 
> > diff --git a/include/linux/hsi/hsi.h b/include/linux/hsi/hsi.h
> > index 5dd60c2e120f..2790591c77cf 100644
> > --- a/include/linux/hsi/hsi.h
> > +++ b/include/linux/hsi/hsi.h
> > @@ -135,9 +135,6 @@ static inline int hsi_register_board_info(struct hsi_board_info const *info,
> >   * @device: Driver model representation of the device
> >   * @tx_cfg: HSI TX configuration
> >   * @rx_cfg: HSI RX configuration
> > - * @e_handler: Callback for handling port events (RX Wake High/Low)
> > - * @pclaimed: Keeps tracks if the clients claimed its associated HSI port
> > - * @nb: Notifier block for port events
> >   */
> >  struct hsi_client {
> >  	struct device		device;
> > 
> 
> Any comments about this patch?

The patch looks fine. I will queue it for 4.5 once 4.4-rc1 has been
released.

-- Sebastian

Download attachment "signature.asc" of type "application/pgp-signature" (820 bytes)