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

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

[Javier Martinez Canillas]

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@osg.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;
-- 
2.4.3

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

[Javier Martinez Canillas]

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@osg.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?

Best regards,
-- 
Javier Martinez Canillas
Open Source Group
Samsung Research America

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

[Sebastian Reichel]

[-- Attachment #1: Type: text/plain, Size: 1821 bytes --]

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@osg.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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

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

[Sebastian Reichel]

[-- Attachment #1: Type: text/plain, Size: 955 bytes --]

Hi,

On Thu, Oct 08, 2015 at 09:11:48AM +0200, 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@osg.samsung.com>

Thanks, queued:

https://git.kernel.org/cgit/linux/kernel/git/sre/linux-hsi.git/commit/?h=for-next&id=403c5c0650816375527a6feecfb255d9b494dda3

-- Sebastian

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]