2023-12-23 05:05:22

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] counter: linux/counter.h: fix Excess kernel-doc description warning

Remove the @priv: line to prevent the kernel-doc warning:

include/linux/counter.h:400: warning: Excess struct member 'priv' description in 'counter_device'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: William Breathitt Gray <[email protected]>
Cc: [email protected]
---
include/linux/counter.h | 1 -
1 file changed, 1 deletion(-)

diff -- a/include/linux/counter.h b/include/linux/counter.h
--- a/include/linux/counter.h
+++ b/include/linux/counter.h
@@ -359,7 +359,6 @@ struct counter_ops {
* @num_counts: number of Counts specified in @counts
* @ext: optional array of Counter device extensions
* @num_ext: number of Counter device extensions specified in @ext
- * @priv: optional private data supplied by driver
* @dev: internal device structure
* @chrdev: internal character device structure
* @events_list: list of current watching Counter events


2023-12-27 14:36:09

by William Breathitt Gray

[permalink] [raw]
Subject: Re: [PATCH] counter: linux/counter.h: fix Excess kernel-doc description warning

On Fri, Dec 22, 2023 at 09:05:11PM -0800, Randy Dunlap wrote:
> Remove the @priv: line to prevent the kernel-doc warning:
>
> include/linux/counter.h:400: warning: Excess struct member 'priv' description in 'counter_device'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: William Breathitt Gray <[email protected]>
> Cc: [email protected]
> ---
> include/linux/counter.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff -- a/include/linux/counter.h b/include/linux/counter.h
> --- a/include/linux/counter.h
> +++ b/include/linux/counter.h
> @@ -359,7 +359,6 @@ struct counter_ops {
> * @num_counts: number of Counts specified in @counts
> * @ext: optional array of Counter device extensions
> * @num_ext: number of Counter device extensions specified in @ext
> - * @priv: optional private data supplied by driver
> * @dev: internal device structure
> * @chrdev: internal character device structure
> * @events_list: list of current watching Counter events

Hi Randy,

Would you provide a Fixes tag for the commit that removed the 'priv'
member so we can track when this warning appeared? You can respond with
it to this thread and I'll add it in when I merge your patch.

Thanks,

William Breathitt Gray


Attachments:
(No filename) (1.26 kB)
signature.asc (235.00 B)
Download all attachments

2023-12-27 21:40:16

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] counter: linux/counter.h: fix Excess kernel-doc description warning



On 12/27/23 06:35, William Breathitt Gray wrote:
> On Fri, Dec 22, 2023 at 09:05:11PM -0800, Randy Dunlap wrote:
>> Remove the @priv: line to prevent the kernel-doc warning:
>>
>> include/linux/counter.h:400: warning: Excess struct member 'priv' description in 'counter_device'
>>
>> Signed-off-by: Randy Dunlap <[email protected]>
>> Cc: William Breathitt Gray <[email protected]>
>> Cc: [email protected]
>> ---
>> include/linux/counter.h | 1 -
>> 1 file changed, 1 deletion(-)
>>
>> diff -- a/include/linux/counter.h b/include/linux/counter.h
>> --- a/include/linux/counter.h
>> +++ b/include/linux/counter.h
>> @@ -359,7 +359,6 @@ struct counter_ops {
>> * @num_counts: number of Counts specified in @counts
>> * @ext: optional array of Counter device extensions
>> * @num_ext: number of Counter device extensions specified in @ext
>> - * @priv: optional private data supplied by driver
>> * @dev: internal device structure
>> * @chrdev: internal character device structure
>> * @events_list: list of current watching Counter events
>
> Hi Randy,
>
> Would you provide a Fixes tag for the commit that removed the 'priv'
> member so we can track when this warning appeared? You can respond with
> it to this thread and I'll add it in when I merge your patch.

Fixes: f2ee4759fb70 ("counter: remove old and now unused registration API")

Thank you.

--
#Randy

2023-12-28 14:47:10

by William Breathitt Gray

[permalink] [raw]
Subject: Re: [PATCH] counter: linux/counter.h: fix Excess kernel-doc description warning

On Wed, Dec 27, 2023 at 01:40:01PM -0800, Randy Dunlap wrote:
>
>
> On 12/27/23 06:35, William Breathitt Gray wrote:
> > On Fri, Dec 22, 2023 at 09:05:11PM -0800, Randy Dunlap wrote:
> >> Remove the @priv: line to prevent the kernel-doc warning:
> >>
> >> include/linux/counter.h:400: warning: Excess struct member 'priv' description in 'counter_device'
> >>
> >> Signed-off-by: Randy Dunlap <[email protected]>
> >> Cc: William Breathitt Gray <[email protected]>
> >> Cc: [email protected]
> >> ---
> >> include/linux/counter.h | 1 -
> >> 1 file changed, 1 deletion(-)
> >>
> >> diff -- a/include/linux/counter.h b/include/linux/counter.h
> >> --- a/include/linux/counter.h
> >> +++ b/include/linux/counter.h
> >> @@ -359,7 +359,6 @@ struct counter_ops {
> >> * @num_counts: number of Counts specified in @counts
> >> * @ext: optional array of Counter device extensions
> >> * @num_ext: number of Counter device extensions specified in @ext
> >> - * @priv: optional private data supplied by driver
> >> * @dev: internal device structure
> >> * @chrdev: internal character device structure
> >> * @events_list: list of current watching Counter events
> >
> > Hi Randy,
> >
> > Would you provide a Fixes tag for the commit that removed the 'priv'
> > member so we can track when this warning appeared? You can respond with
> > it to this thread and I'll add it in when I merge your patch.
>
> Fixes: f2ee4759fb70 ("counter: remove old and now unused registration API")
>
> Thank you.
>
> --
> #Randy

Applied, thanks!

[1/1] counter: linux/counter.h: fix Excess kernel-doc description warning
commit: 49ca40f8d6ceb76bff83713f79215d8e6252f045

William Breathitt Gray


Attachments:
(No filename) (1.73 kB)
signature.asc (235.00 B)
Download all attachments