* [PATCH] reset: fix kernel-doc warnings
@ 2019-10-23 3:57 Randy Dunlap
2019-10-24 8:47 ` Philipp Zabel
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2019-10-23 3:57 UTC (permalink / raw)
To: LKML, Philipp Zabel; +Cc: linux-doc
From: Randy Dunlap <rdunlap@infradead.org>
Fix kernel-doc warnings discovered in the reset controller API chapter.
Fixes these warnings:
./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
./drivers/reset/core.c:838: warning: Function parameter or member 'node' not described in 'of_reset_control_get_count'
./include/linux/reset-controller.h:45: warning: Function parameter or member 'con_id' not described in 'reset_control_lookup'
./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Philipp Zabel <p.zabel@pengutronix.de>
---
drivers/reset/core.c | 4 ++--
include/linux/reset-controller.h | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
--- linux-next-20191022.orig/drivers/reset/core.c
+++ linux-next-20191022/drivers/reset/core.c
@@ -76,7 +76,6 @@ static const char *rcdev_name(struct res
* of_reset_simple_xlate - translate reset_spec to the reset line number
* @rcdev: a pointer to the reset controller device
* @reset_spec: reset line specifier as found in the device tree
- * @flags: a flags pointer to fill in (optional)
*
* This simple translation function should be used for reset controllers
* with 1:1 mapping, where reset lines can be indexed by number without gaps.
@@ -823,9 +822,10 @@ int __device_reset(struct device *dev, b
}
EXPORT_SYMBOL_GPL(__device_reset);
-/**
+/*
* APIs to manage an array of reset controls.
*/
+
/**
* of_reset_control_get_count - Count number of resets available with a device
*
--- linux-next-20191022.orig/include/linux/reset-controller.h
+++ linux-next-20191022/include/linux/reset-controller.h
@@ -7,7 +7,7 @@
struct reset_controller_dev;
/**
- * struct reset_control_ops
+ * struct reset_control_ops - reset controller driver callbacks
*
* @reset: for self-deasserting resets, does all necessary
* things to reset the device
@@ -33,7 +33,7 @@ struct of_phandle_args;
* @provider: name of the reset controller device controlling this reset line
* @index: ID of the reset controller in the reset controller device
* @dev_id: name of the device associated with this reset line
- * @con_id name of the reset line (can be NULL)
+ * @con_id: name of the reset line (can be NULL)
*/
struct reset_control_lookup {
struct list_head list;
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] reset: fix kernel-doc warnings
2019-10-23 3:57 [PATCH] reset: fix kernel-doc warnings Randy Dunlap
@ 2019-10-24 8:47 ` Philipp Zabel
2019-10-24 15:26 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Philipp Zabel @ 2019-10-24 8:47 UTC (permalink / raw)
To: Randy Dunlap, LKML; +Cc: linux-doc
Hi Randy,
thank you for the fixes.
On Tue, 2019-10-22 at 20:57 -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warnings discovered in the reset controller API chapter.
> Fixes these warnings:
>
> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
> ./drivers/reset/core.c:838: warning: Function parameter or member 'node' not described in 'of_reset_control_get_count'
> ./include/linux/reset-controller.h:45: warning: Function parameter or member 'con_id' not described in 'reset_control_lookup'
> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Philipp Zabel <p.zabel@pengutronix.de>
> ---
> drivers/reset/core.c | 4 ++--
> include/linux/reset-controller.h | 4 ++--
[...]
> @@ -7,7 +7,7 @@
> struct reset_controller_dev;
>
> /**
> - * struct reset_control_ops
> + * struct reset_control_ops - reset controller driver callbacks
> *
> * @reset: for self-deasserting resets, does all necessary
> * things to reset the device
This is all that remains when I rebase onto reset/fixes. Ok to apply
this and change the commit message to:
reset: fix reset_control_ops kerneldoc comment
Add a missing short description to the reset_control_ops
documentation.
?
regards
Philipp
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] reset: fix kernel-doc warnings
2019-10-24 8:47 ` Philipp Zabel
@ 2019-10-24 15:26 ` Randy Dunlap
0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2019-10-24 15:26 UTC (permalink / raw)
To: Philipp Zabel, LKML; +Cc: linux-doc
On 10/24/19 1:47 AM, Philipp Zabel wrote:
> Hi Randy,
>
> thank you for the fixes.
>
> On Tue, 2019-10-22 at 20:57 -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix kernel-doc warnings discovered in the reset controller API chapter.
>> Fixes these warnings:
>>
>> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
>> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
>> ./drivers/reset/core.c:838: warning: Function parameter or member 'node' not described in 'of_reset_control_get_count'
>> ./include/linux/reset-controller.h:45: warning: Function parameter or member 'con_id' not described in 'reset_control_lookup'
>> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
>> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Philipp Zabel <p.zabel@pengutronix.de>
>> ---
>> drivers/reset/core.c | 4 ++--
>> include/linux/reset-controller.h | 4 ++--
> [...]
>> @@ -7,7 +7,7 @@
>> struct reset_controller_dev;
>>
>> /**
>> - * struct reset_control_ops
>> + * struct reset_control_ops - reset controller driver callbacks
>> *
>> * @reset: for self-deasserting resets, does all necessary
>> * things to reset the device
>
> This is all that remains when I rebase onto reset/fixes. Ok to apply
> this and change the commit message to:
>
> reset: fix reset_control_ops kerneldoc comment
>
> Add a missing short description to the reset_control_ops
> documentation.
>
> ?
Of course. Go for it.
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-10-24 15:26 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-23 3:57 [PATCH] reset: fix kernel-doc warnings Randy Dunlap
2019-10-24 8:47 ` Philipp Zabel
2019-10-24 15:26 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).