diff mbox series

counter: linux/counter.h: fix Excess kernel-doc description warning

Message ID 20231223050511.13849-1-rdunlap@infradead.org
State New
Headers
Series counter: linux/counter.h: fix Excess kernel-doc description warning |

Commit Message

Randy Dunlap Dec. 23, 2023, 5:05 a.m. UTC 
  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 <rdunlap@infradead.org>
Cc: William Breathitt Gray <william.gray@linaro.org>
Cc: linux-iio@vger.kernel.org
---
 include/linux/counter.h |    1 -
 1 file changed, 1 deletion(-)

Comments

William Breathitt Gray Dec. 27, 2023, 2:35 p.m. UTC | #1 
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 <rdunlap@infradead.org>
> Cc: William Breathitt Gray <william.gray@linaro.org>
> Cc: linux-iio@vger.kernel.org
> ---
>  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
Randy Dunlap Dec. 27, 2023, 9:40 p.m. UTC | #2 
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 <rdunlap@infradead.org>
>> Cc: William Breathitt Gray <william.gray@linaro.org>
>> Cc: linux-iio@vger.kernel.org
>> ---
>>  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.
William Breathitt Gray Dec. 28, 2023, 2:46 p.m. UTC | #3 
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 <rdunlap@infradead.org>
> >> Cc: William Breathitt Gray <william.gray@linaro.org>
> >> Cc: linux-iio@vger.kernel.org
> >> ---
> >>  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
diff mbox series

Patch

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