gpiolib: cdev: Fix kernel doc for struct line
PATCH 1/1 gpiolib: cdev: Fix kernel doc for struct line
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.
--- drivers/gpio/gpiolib-cdev.c | 4 ++++ 1 file changed, 4 insertions(+)
drivers/gpio/gpiolib-cdev.c +4 -0
@@ -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;
Signature · 1 line
2.35.1
Quoted 29 lines · 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 <[email protected]>--- drivers/gpio/gpiolib-cdev.c | 4 ++++ 1 file changed, 4 insertions(+)drivers/gpio/gpiolib-cdev.c +4
-0@@ -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;
Quoted 1 line · Dipen Patel
Acked-by Dipen Patel <[email protected]>
Thanks!
Bart, this can be applied, I think.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 6 lines · Andy Shevchenko
Quoted 1 line · Dipen Patel
Acked-by Dipen Patel <[email protected]>Thanks!
Bart, this can be applied, I think.
Or do you want it in my PR?
Signature · 2 lines
With Best Regards, Andy Shevchenko
A message that is not in the archive (sent off-list or not yet received): CA+PwDYdf7JEimfYG9ChTHp=Dds_Ljx1Y2KK-H5zfeu52=NxXFA@mail.gmail.com
Quoted 9 lines · Thierry Reding
Quoted 6 lines · On Fri, 3 Jun 2022, 19:28 Andy Shevchenko, <…
Quoted 5 lines · Andy Shevchenko
Quoted 1 line · Dipen Patel
Acked-by Dipen Patel <[email protected]>Thanks!
Quoted 8 lines
Quoted 4 lines
Quoted 1 line
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.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Hi Thierry,
We need this patch to get rid off document warnings.
Best Regards,
Dipen Patel
Quoted 18 lines · Andy Shevchenko
Quoted 6 lines · Thierry Reding
Quoted 3 lines · On Fri, 3 Jun 2022, 19:28 Andy Shevchenko, <…
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Dipen Patel
Acked-by Dipen Patel <[email protected]>Quoted 8 lines
Quoted 5 lines
Quoted 3 lines
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.
Quoted 31 lines · 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 <[email protected]>--- drivers/gpio/gpiolib-cdev.c | 4 ++++ 1 file changed, 4 insertions(+)drivers/gpio/gpiolib-cdev.c +4
-1@@ -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; --
Quoted 2 lines
2.35.1
Feel free to take it through whatever tree is appropriate.
Bart