Re: [PATCH v1 1/1] gpiolib: cdev: Fix kernel doc for struct line

From: Bartosz Golaszewski
Date: Thu Jun 09 2022 - 05:34:33 EST


On Fri, May 20, 2022 at 6:47 PM Andy Shevchenko
<andriy.shevchenko@xxxxxxxxxxxxxxx> wrote:
>
> Kernel doc validator is not happy:
> gpiolib-cdev.c:487: warning: Function parameter or member 'hdesc' not described in 'line'
> gpiolib-cdev.c:487: warning: Function parameter or member 'raw_level' not described in 'line'
> gpiolib-cdev.c:487: warning: Function parameter or member 'total_discard_seq' not described in 'line'
> gpiolib-cdev.c:487: warning: Function parameter or member 'last_seqno' not described in 'line'
>
> Describe above mentioned parameters.
>
> Fixes: 2068339a6c35 ("gpiolib: cdev: Add hardware timestamp clock type")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> ---
> drivers/gpio/gpiolib-cdev.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/drivers/gpio/gpiolib-cdev.c b/drivers/gpio/gpiolib-cdev.c
> index f5aa5f93342a..d0dc68d04059 100644
> --- a/drivers/gpio/gpiolib-cdev.c
> +++ b/drivers/gpio/gpiolib-cdev.c
> @@ -421,6 +421,10 @@ static int linehandle_create(struct gpio_device *gdev, void __user *ip)
> * @work: the worker that implements software debouncing
> * @sw_debounced: flag indicating if the software debouncer is active
> * @level: the current debounced physical level of the line
> + * @hdesc: the Hardware Timestamp Engine (HTE) descriptor
> + * @raw_level: the line level at the time of event
> + * @total_discard_seq: the running counter of the discarded events
> + * @last_seqno: the last sequence number before debounce period expires
> */
> struct line {
> struct gpio_desc *desc;
> --
> 2.35.1
>

Acked-by: Bartosz Golaszewski <brgl@xxxxxxxx>

Feel free to take it through whatever tree is appropriate.

Bart