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

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

[Andy Shevchenko]

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@linux.intel.com>
---
 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

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

[Dipen Patel]

Acked-by: Dipen Patel <dipenp@nvidia.com>

On 5/20/22 9:47 AM, Andy Shevchenko 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@linux.intel.com>
> ---
>  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;

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

[Andy Shevchenko]

On Fri, May 20, 2022 at 10:10:49AM -0700, Dipen Patel wrote:
> Acked-by: Dipen Patel <dipenp@nvidia.com>

Thanks!

Bart, this can be applied, I think.

-- 
With Best Regards,
Andy Shevchenko

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

[Andy Shevchenko]

On Fri, Jun 03, 2022 at 08:28:09PM +0300, Andy Shevchenko wrote:
> On Fri, May 20, 2022 at 10:10:49AM -0700, Dipen Patel wrote:
> > Acked-by: Dipen Patel <dipenp@nvidia.com>
> 
> Thanks!
> 
> Bart, this can be applied, I think.

Or do you want it in my PR?

-- 
With Best Regards,
Andy Shevchenko

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

[Andy Shevchenko]

On Sun, Jun 05, 2022 at 01:11:54AM +0200, Thierry Reding wrote:
> On Fri, 3 Jun 2022, 19:28 Andy Shevchenko, <
> andriy.shevchenko@linux.intel.com> wrote:
> 
> > On Fri, Jun 03, 2022 at 08:28:09PM +0300, Andy Shevchenko wrote:
> > > On Fri, May 20, 2022 at 10:10:49AM -0700, Dipen Patel wrote:
> > > > Acked-by: Dipen Patel <dipenp@nvidia.com>
> > >
> > > Thanks!
> > >
> > > Bart, this can be applied, I think.
> >
> > Or do you want it in my PR?
> >
> 
> This would need to go in through the HTE tree.
> 
> I can pick it up, but it looks like Linus isn't happy with this yet anyway.

It's merged as far as I can see. Feel free to pick it up, I'll drop it from my
tree.

-- 
With Best Regards,
Andy Shevchenko

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

[Dipen Patel]

Hi Thierry,

We need this patch to get rid off document warnings.

Best Regards,

Dipen Patel

On 6/6/22 3:05 AM, Andy Shevchenko wrote:
> On Sun, Jun 05, 2022 at 01:11:54AM +0200, Thierry Reding wrote:
>> On Fri, 3 Jun 2022, 19:28 Andy Shevchenko, <
>> andriy.shevchenko@linux.intel.com> wrote:
>>
>>> On Fri, Jun 03, 2022 at 08:28:09PM +0300, Andy Shevchenko wrote:
>>>> On Fri, May 20, 2022 at 10:10:49AM -0700, Dipen Patel wrote:
>>>>> Acked-by: Dipen Patel <dipenp@nvidia.com>
>>>> Thanks!
>>>>
>>>> Bart, this can be applied, I think.
>>> Or do you want it in my PR?
>>>
>> This would need to go in through the HTE tree.
>>
>> I can pick it up, but it looks like Linus isn't happy with this yet anyway.
> It's merged as far as I can see. Feel free to pick it up, I'll drop it from my
> tree.
>

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

[Bartosz Golaszewski]

On Fri, May 20, 2022 at 6:47 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> 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@linux.intel.com>
> ---
>  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@bgdev.pl>

Feel free to take it through whatever tree is appropriate.

Bart