* [RFC PATCH 0/2] fpga: fix kernel-doc warnings and align descriptions for the core components
@ 2023-07-06 14:27 Marco Pagani
2023-07-06 14:27 ` [RFC PATCH 1/2] fpga: region: fix kernel-doc Marco Pagani
2023-07-06 14:27 ` [RFC PATCH 2/2] fpga: bridge: " Marco Pagani
0 siblings, 2 replies; 9+ messages in thread
From: Marco Pagani @ 2023-07-06 14:27 UTC (permalink / raw)
To: Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: Marco Pagani, linux-kernel, linux-fpga
This patch set fixes all kernel-doc warnings reported by the kernel-doc
script for the core components of the subsystem and aligns descriptions
with current implementations
Marco Pagani (2):
fpga: region: fix kernel-doc
fpga: bridge: fix kernel-doc
drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
drivers/fpga/fpga-region.c | 14 ++++++++------
2 files changed, 20 insertions(+), 17 deletions(-)
base-commit: 45a3e24f65e90a047bef86f927ebdc4c710edaa1
--
2.41.0
^ permalink raw reply [flat|nested] 9+ messages in thread
* [RFC PATCH 1/2] fpga: region: fix kernel-doc
2023-07-06 14:27 [RFC PATCH 0/2] fpga: fix kernel-doc warnings and align descriptions for the core components Marco Pagani
@ 2023-07-06 14:27 ` Marco Pagani
2023-07-06 21:30 ` Randy Dunlap
2023-07-06 14:27 ` [RFC PATCH 2/2] fpga: bridge: " Marco Pagani
1 sibling, 1 reply; 9+ messages in thread
From: Marco Pagani @ 2023-07-06 14:27 UTC (permalink / raw)
To: Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: Marco Pagani, linux-kernel, linux-fpga
- Fix the following warnings issued by the kernel-doc script:
drivers/fpga/fpga-region.c:46: warning: No description found for return value of 'fpga_region_get'
drivers/fpga/fpga-region.c:97: warning: No description found for return value of 'fpga_region_program_fpga'
drivers/fpga/fpga-region.c:295: warning: No description found for return value of 'fpga_region_init'
- Remove the "and registers a reconfig notifier" part from the description
of fpga_region_init() since it does not register an of_overlay notifier
anymore.
- Remove the outdated "if @np is not an FPGA Region" case from the return
description of fpga_region_get() and replace it with the case when
try_module_get() fails.
Signed-off-by: Marco Pagani <marpagan@redhat.com>
---
drivers/fpga/fpga-region.c | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
index ccf6fdab1360..c9d065a6961b 100644
--- a/drivers/fpga/fpga-region.c
+++ b/drivers/fpga/fpga-region.c
@@ -38,9 +38,10 @@ EXPORT_SYMBOL_GPL(fpga_region_class_find);
*
* Caller should call fpga_region_put() when done with region.
*
- * Return fpga_region struct if successful.
- * Return -EBUSY if someone already has a reference to the region.
- * Return -ENODEV if @np is not an FPGA Region.
+ * Return:
+ * * fpga_region struct if successful.
+ * * -EBUSY if someone already has a reference to the region.
+ * * -ENODEV if can't take parent driver module refcount.
*/
static struct fpga_region *fpga_region_get(struct fpga_region *region)
{
@@ -91,7 +92,7 @@ static void fpga_region_put(struct fpga_region *region)
* The caller will need to call fpga_bridges_put() before attempting to
* reprogram the region.
*
- * Return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
int fpga_region_program_fpga(struct fpga_region *region)
{
@@ -288,8 +289,9 @@ static void fpga_region_dev_release(struct device *dev)
}
/**
- * fpga_region_init - init function for fpga_region class
- * Creates the fpga_region class and registers a reconfig notifier.
+ * fpga_region_init - creates the fpga_region class.
+ *
+ * Return: 0 on success or ERR_PTR() on error.
*/
static int __init fpga_region_init(void)
{
--
2.41.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
2023-07-06 14:27 [RFC PATCH 0/2] fpga: fix kernel-doc warnings and align descriptions for the core components Marco Pagani
2023-07-06 14:27 ` [RFC PATCH 1/2] fpga: region: fix kernel-doc Marco Pagani
@ 2023-07-06 14:27 ` Marco Pagani
2023-07-06 21:35 ` Randy Dunlap
1 sibling, 1 reply; 9+ messages in thread
From: Marco Pagani @ 2023-07-06 14:27 UTC (permalink / raw)
To: Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: Marco Pagani, linux-kernel, linux-fpga
Fix the following warnings issued by the kernel-doc script:
drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
- Extend the return description of of_fpga_bridge_get() to include the
case when try_module_get() fails.
Signed-off-by: Marco Pagani <marpagan@redhat.com>
---
drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
index a6c25dee9cc1..0b76c67c50e5 100644
--- a/drivers/fpga/fpga-bridge.c
+++ b/drivers/fpga/fpga-bridge.c
@@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
/**
* of_fpga_bridge_get - get an exclusive reference to an fpga bridge
*
- * @np: node pointer of an FPGA bridge
- * @info: fpga image specific information
+ * @np: node pointer of an FPGA bridge.
+ * @info: fpga image specific information.
*
- * Return fpga_bridge struct if successful.
- * Return -EBUSY if someone already has a reference to the bridge.
- * Return -ENODEV if @np is not an FPGA Bridge.
+ * Return:
+ * * fpga_bridge struct pointer if successful.
+ * * -EBUSY if someone already has a reference to the bridge.
+ * * -ENODEV if @np is not an FPGA Bridge or can't take parent driver refcount.
*/
struct fpga_bridge *of_fpga_bridge_get(struct device_node *np,
struct fpga_image_info *info)
@@ -155,9 +156,9 @@ EXPORT_SYMBOL_GPL(fpga_bridge_put);
* fpga_bridges_enable - enable bridges in a list
* @bridge_list: list of FPGA bridges
*
- * Enable each bridge in the list. If list is empty, do nothing.
+ * Enable each bridge in the list. If list is empty, do nothing.
*
- * Return 0 for success or empty bridge list; return error code otherwise.
+ * Return: 0 for success or empty bridge list or an error code otherwise.
*/
int fpga_bridges_enable(struct list_head *bridge_list)
{
@@ -179,9 +180,9 @@ EXPORT_SYMBOL_GPL(fpga_bridges_enable);
*
* @bridge_list: list of FPGA bridges
*
- * Disable each bridge in the list. If list is empty, do nothing.
+ * Disable each bridge in the list. If list is empty, do nothing.
*
- * Return 0 for success or empty bridge list; return error code otherwise.
+ * Return: 0 for success or empty bridge list or an error code otherwise.
*/
int fpga_bridges_disable(struct list_head *bridge_list)
{
@@ -230,7 +231,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_put);
*
* Get an exclusive reference to the bridge and it to the list.
*
- * Return 0 for success, error code from of_fpga_bridge_get() otherwise.
+ * Return: 0 for success, error code from of_fpga_bridge_get() otherwise.
*/
int of_fpga_bridge_get_to_list(struct device_node *np,
struct fpga_image_info *info,
@@ -260,7 +261,7 @@ EXPORT_SYMBOL_GPL(of_fpga_bridge_get_to_list);
*
* Get an exclusive reference to the bridge and it to the list.
*
- * Return 0 for success, error code from fpga_bridge_get() otherwise.
+ * Return: 0 for success, error code from fpga_bridge_get() otherwise.
*/
int fpga_bridge_get_to_list(struct device *dev,
struct fpga_image_info *info,
--
2.41.0
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 1/2] fpga: region: fix kernel-doc
2023-07-06 14:27 ` [RFC PATCH 1/2] fpga: region: fix kernel-doc Marco Pagani
@ 2023-07-06 21:30 ` Randy Dunlap
2023-07-10 8:05 ` Xu Yilun
0 siblings, 1 reply; 9+ messages in thread
From: Randy Dunlap @ 2023-07-06 21:30 UTC (permalink / raw)
To: Marco Pagani, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: linux-kernel, linux-fpga
Hi--
On 7/6/23 07:27, Marco Pagani wrote:
> - Fix the following warnings issued by the kernel-doc script:
>
> drivers/fpga/fpga-region.c:46: warning: No description found for return value of 'fpga_region_get'
> drivers/fpga/fpga-region.c:97: warning: No description found for return value of 'fpga_region_program_fpga'
> drivers/fpga/fpga-region.c:295: warning: No description found for return value of 'fpga_region_init'
>
> - Remove the "and registers a reconfig notifier" part from the description
> of fpga_region_init() since it does not register an of_overlay notifier
> anymore.
>
> - Remove the outdated "if @np is not an FPGA Region" case from the return
> description of fpga_region_get() and replace it with the case when
> try_module_get() fails.
>
> Signed-off-by: Marco Pagani <marpagan@redhat.com>
Looks good. Thanks.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> drivers/fpga/fpga-region.c | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
> index ccf6fdab1360..c9d065a6961b 100644
> --- a/drivers/fpga/fpga-region.c
> +++ b/drivers/fpga/fpga-region.c
> @@ -38,9 +38,10 @@ EXPORT_SYMBOL_GPL(fpga_region_class_find);
> *
> * Caller should call fpga_region_put() when done with region.
> *
> - * Return fpga_region struct if successful.
> - * Return -EBUSY if someone already has a reference to the region.
> - * Return -ENODEV if @np is not an FPGA Region.
> + * Return:
> + * * fpga_region struct if successful.
> + * * -EBUSY if someone already has a reference to the region.
> + * * -ENODEV if can't take parent driver module refcount.
> */
> static struct fpga_region *fpga_region_get(struct fpga_region *region)
> {
> @@ -91,7 +92,7 @@ static void fpga_region_put(struct fpga_region *region)
> * The caller will need to call fpga_bridges_put() before attempting to
> * reprogram the region.
> *
> - * Return 0 for success or negative error code.
> + * Return: 0 for success or negative error code.
> */
> int fpga_region_program_fpga(struct fpga_region *region)
> {
> @@ -288,8 +289,9 @@ static void fpga_region_dev_release(struct device *dev)
> }
>
> /**
> - * fpga_region_init - init function for fpga_region class
> - * Creates the fpga_region class and registers a reconfig notifier.
> + * fpga_region_init - creates the fpga_region class.
> + *
> + * Return: 0 on success or ERR_PTR() on error.
> */
> static int __init fpga_region_init(void)
> {
--
~Randy
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
2023-07-06 14:27 ` [RFC PATCH 2/2] fpga: bridge: " Marco Pagani
@ 2023-07-06 21:35 ` Randy Dunlap
2023-07-06 21:37 ` Randy Dunlap
2023-07-07 8:50 ` Marco Pagani
0 siblings, 2 replies; 9+ messages in thread
From: Randy Dunlap @ 2023-07-06 21:35 UTC (permalink / raw)
To: Marco Pagani, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: linux-kernel, linux-fpga
HI--
On 7/6/23 07:27, Marco Pagani wrote:
> Fix the following warnings issued by the kernel-doc script:
>
> drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
> drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
> drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
> drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
> drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
>
> - Extend the return description of of_fpga_bridge_get() to include the
> case when try_module_get() fails.
>
> Signed-off-by: Marco Pagani <marpagan@redhat.com>
> ---
> drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
> 1 file changed, 12 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> index a6c25dee9cc1..0b76c67c50e5 100644
> --- a/drivers/fpga/fpga-bridge.c
> +++ b/drivers/fpga/fpga-bridge.c
> @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
> /**
> * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
> *
> - * @np: node pointer of an FPGA bridge
> - * @info: fpga image specific information
> + * @np: node pointer of an FPGA bridge.
> + * @info: fpga image specific information.
Those are not sentences. There is no reason that a period ('.') is needed
to end those lines. OTOH, the maintainers can do as they like with it.
The rest looks good. Thanks.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> *
> - * Return fpga_bridge struct if successful.
> - * Return -EBUSY if someone already has a reference to the bridge.
> - * Return -ENODEV if @np is not an FPGA Bridge.
> + * Return:
> + * * fpga_bridge struct pointer if successful.
> + * * -EBUSY if someone already has a reference to the bridge.
> + * * -ENODEV if @np is not an FPGA Bridge or can't take parent driver refcount.
> */
> struct fpga_bridge *of_fpga_bridge_get(struct device_node *np,
> struct fpga_image_info *info)
> @@ -155,9 +156,9 @@ EXPORT_SYMBOL_GPL(fpga_bridge_put);
> * fpga_bridges_enable - enable bridges in a list
> * @bridge_list: list of FPGA bridges
> *
> - * Enable each bridge in the list. If list is empty, do nothing.
> + * Enable each bridge in the list. If list is empty, do nothing.
> *
> - * Return 0 for success or empty bridge list; return error code otherwise.
> + * Return: 0 for success or empty bridge list or an error code otherwise.
> */
> int fpga_bridges_enable(struct list_head *bridge_list)
> {
> @@ -179,9 +180,9 @@ EXPORT_SYMBOL_GPL(fpga_bridges_enable);
> *
> * @bridge_list: list of FPGA bridges
> *
> - * Disable each bridge in the list. If list is empty, do nothing.
> + * Disable each bridge in the list. If list is empty, do nothing.
> *
> - * Return 0 for success or empty bridge list; return error code otherwise.
> + * Return: 0 for success or empty bridge list or an error code otherwise.
> */
> int fpga_bridges_disable(struct list_head *bridge_list)
> {
> @@ -230,7 +231,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_put);
> *
> * Get an exclusive reference to the bridge and it to the list.
> *
> - * Return 0 for success, error code from of_fpga_bridge_get() otherwise.
> + * Return: 0 for success, error code from of_fpga_bridge_get() otherwise.
> */
> int of_fpga_bridge_get_to_list(struct device_node *np,
> struct fpga_image_info *info,
> @@ -260,7 +261,7 @@ EXPORT_SYMBOL_GPL(of_fpga_bridge_get_to_list);
> *
> * Get an exclusive reference to the bridge and it to the list.
> *
> - * Return 0 for success, error code from fpga_bridge_get() otherwise.
> + * Return: 0 for success, error code from fpga_bridge_get() otherwise.
> */
> int fpga_bridge_get_to_list(struct device *dev,
> struct fpga_image_info *info,
--
~Randy
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
2023-07-06 21:35 ` Randy Dunlap
@ 2023-07-06 21:37 ` Randy Dunlap
2023-07-07 8:50 ` Marco Pagani
1 sibling, 0 replies; 9+ messages in thread
From: Randy Dunlap @ 2023-07-06 21:37 UTC (permalink / raw)
To: Marco Pagani, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: linux-kernel, linux-fpga
Hi again,
On 7/6/23 14:35, Randy Dunlap wrote:
> HI--
>
> On 7/6/23 07:27, Marco Pagani wrote:
>> Fix the following warnings issued by the kernel-doc script:
>>
>> drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
>> drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
>> drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
>> drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
>> drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
>>
>> - Extend the return description of of_fpga_bridge_get() to include the
>> case when try_module_get() fails.
>>
>> Signed-off-by: Marco Pagani <marpagan@redhat.com>
>> ---
>> drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
>> 1 file changed, 12 insertions(+), 11 deletions(-)
>>
>> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
>> index a6c25dee9cc1..0b76c67c50e5 100644
>> --- a/drivers/fpga/fpga-bridge.c
>> +++ b/drivers/fpga/fpga-bridge.c
>> @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
>> /**
>> * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
>> *
>> - * @np: node pointer of an FPGA bridge
>> - * @info: fpga image specific information
>> + * @np: node pointer of an FPGA bridge.
>> + * @info: fpga image specific information.
>
> Those are not sentences. There is no reason that a period ('.') is needed
> to end those lines. OTOH, the maintainers can do as they like with it.
>
> The rest looks good. Thanks.
>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
>
>> *
>> - * Return fpga_bridge struct if successful.
>> - * Return -EBUSY if someone already has a reference to the bridge.
>> - * Return -ENODEV if @np is not an FPGA Bridge.
>> + * Return:
>> + * * fpga_bridge struct pointer if successful.
>> + * * -EBUSY if someone already has a reference to the bridge.
>> + * * -ENODEV if @np is not an FPGA Bridge or can't take parent driver refcount.
>> */
>> struct fpga_bridge *of_fpga_bridge_get(struct device_node *np,
>> struct fpga_image_info *info)
>> @@ -155,9 +156,9 @@ EXPORT_SYMBOL_GPL(fpga_bridge_put);
>> * fpga_bridges_enable - enable bridges in a list
>> * @bridge_list: list of FPGA bridges
>> *
>> - * Enable each bridge in the list. If list is empty, do nothing.
>> + * Enable each bridge in the list. If list is empty, do nothing.
These (multiple) 2-space to 1-space changes also are not necessary but are at the
discretion of the maintainers.
>> *
>> - * Return 0 for success or empty bridge list; return error code otherwise.
>> + * Return: 0 for success or empty bridge list or an error code otherwise.
>> */
>> int fpga_bridges_enable(struct list_head *bridge_list)
>> {
>> @@ -179,9 +180,9 @@ EXPORT_SYMBOL_GPL(fpga_bridges_enable);
>> *
>> * @bridge_list: list of FPGA bridges
>> *
>> - * Disable each bridge in the list. If list is empty, do nothing.
>> + * Disable each bridge in the list. If list is empty, do nothing.
>> *
>> - * Return 0 for success or empty bridge list; return error code otherwise.
>> + * Return: 0 for success or empty bridge list or an error code otherwise.
>> */
>> int fpga_bridges_disable(struct list_head *bridge_list)
>> {
>> @@ -230,7 +231,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_put);
>> *
>> * Get an exclusive reference to the bridge and it to the list.
>> *
>> - * Return 0 for success, error code from of_fpga_bridge_get() otherwise.
>> + * Return: 0 for success, error code from of_fpga_bridge_get() otherwise.
>> */
>> int of_fpga_bridge_get_to_list(struct device_node *np,
>> struct fpga_image_info *info,
>> @@ -260,7 +261,7 @@ EXPORT_SYMBOL_GPL(of_fpga_bridge_get_to_list);
>> *
>> * Get an exclusive reference to the bridge and it to the list.
>> *
>> - * Return 0 for success, error code from fpga_bridge_get() otherwise.
>> + * Return: 0 for success, error code from fpga_bridge_get() otherwise.
>> */
>> int fpga_bridge_get_to_list(struct device *dev,
>> struct fpga_image_info *info,
>
--
~Randy
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
2023-07-06 21:35 ` Randy Dunlap
2023-07-06 21:37 ` Randy Dunlap
@ 2023-07-07 8:50 ` Marco Pagani
2023-07-10 8:06 ` Xu Yilun
1 sibling, 1 reply; 9+ messages in thread
From: Marco Pagani @ 2023-07-07 8:50 UTC (permalink / raw)
To: Randy Dunlap, Moritz Fischer, Wu Hao, Xu Yilun, Tom Rix
Cc: linux-kernel, linux-fpga
On 2023-07-06 23:35, Randy Dunlap wrote:
> HI--
>
> On 7/6/23 07:27, Marco Pagani wrote:
>> Fix the following warnings issued by the kernel-doc script:
>>
>> drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
>> drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
>> drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
>> drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
>> drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
>>
>> - Extend the return description of of_fpga_bridge_get() to include the
>> case when try_module_get() fails.
>>
>> Signed-off-by: Marco Pagani <marpagan@redhat.com>
>> ---
>> drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
>> 1 file changed, 12 insertions(+), 11 deletions(-)
>>
>> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
>> index a6c25dee9cc1..0b76c67c50e5 100644
>> --- a/drivers/fpga/fpga-bridge.c
>> +++ b/drivers/fpga/fpga-bridge.c
>> @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
>> /**
>> * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
>> *
>> - * @np: node pointer of an FPGA bridge
>> - * @info: fpga image specific information
>> + * @np: node pointer of an FPGA bridge.
>> + * @info: fpga image specific information.
>
> Those are not sentences. There is no reason that a period ('.') is needed
> to end those lines. OTOH, the maintainers can do as they like with it.
>
> The rest looks good. Thanks.
>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
I added a period at the end of each argument description to follow
the style recommended in the "Function documentation" section of the
kernel-doc documentation.
Thanks,
Marco
[...]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 1/2] fpga: region: fix kernel-doc
2023-07-06 21:30 ` Randy Dunlap
@ 2023-07-10 8:05 ` Xu Yilun
0 siblings, 0 replies; 9+ messages in thread
From: Xu Yilun @ 2023-07-10 8:05 UTC (permalink / raw)
To: Randy Dunlap, marpagan
Cc: Marco Pagani, Moritz Fischer, Wu Hao, Tom Rix, linux-kernel, linux-fpga
On 2023-07-06 at 14:30:34 -0700, Randy Dunlap wrote:
> Hi--
>
> On 7/6/23 07:27, Marco Pagani wrote:
> > - Fix the following warnings issued by the kernel-doc script:
> >
> > drivers/fpga/fpga-region.c:46: warning: No description found for return value of 'fpga_region_get'
> > drivers/fpga/fpga-region.c:97: warning: No description found for return value of 'fpga_region_program_fpga'
> > drivers/fpga/fpga-region.c:295: warning: No description found for return value of 'fpga_region_init'
> >
> > - Remove the "and registers a reconfig notifier" part from the description
> > of fpga_region_init() since it does not register an of_overlay notifier
> > anymore.
> >
> > - Remove the outdated "if @np is not an FPGA Region" case from the return
> > description of fpga_region_get() and replace it with the case when
> > try_module_get() fails.
> >
> > Signed-off-by: Marco Pagani <marpagan@redhat.com>
>
> Looks good. Thanks.
>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Xu Yilun <yilun.xu@intel.com>
Applied.
BTW: No need to have RFC if you think it is ready for full review.
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
2023-07-07 8:50 ` Marco Pagani
@ 2023-07-10 8:06 ` Xu Yilun
0 siblings, 0 replies; 9+ messages in thread
From: Xu Yilun @ 2023-07-10 8:06 UTC (permalink / raw)
To: Marco Pagani
Cc: Randy Dunlap, Moritz Fischer, Wu Hao, Tom Rix, linux-kernel, linux-fpga
On 2023-07-07 at 10:50:16 +0200, Marco Pagani wrote:
>
>
> On 2023-07-06 23:35, Randy Dunlap wrote:
> > HI--
> >
> > On 7/6/23 07:27, Marco Pagani wrote:
> >> Fix the following warnings issued by the kernel-doc script:
> >>
> >> drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
> >> drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
> >> drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
> >> drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
> >> drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'
> >>
> >> - Extend the return description of of_fpga_bridge_get() to include the
> >> case when try_module_get() fails.
> >>
> >> Signed-off-by: Marco Pagani <marpagan@redhat.com>
> >> ---
> >> drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
> >> 1 file changed, 12 insertions(+), 11 deletions(-)
> >>
> >> diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> >> index a6c25dee9cc1..0b76c67c50e5 100644
> >> --- a/drivers/fpga/fpga-bridge.c
> >> +++ b/drivers/fpga/fpga-bridge.c
> >> @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev,
> >> /**
> >> * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
> >> *
> >> - * @np: node pointer of an FPGA bridge
> >> - * @info: fpga image specific information
> >> + * @np: node pointer of an FPGA bridge.
> >> + * @info: fpga image specific information.
> >
> > Those are not sentences. There is no reason that a period ('.') is needed
> > to end those lines. OTOH, the maintainers can do as they like with it.
> >
> > The rest looks good. Thanks.
> >
> > Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
>
> I added a period at the end of each argument description to follow
> the style recommended in the "Function documentation" section of the
> kernel-doc documentation.
I'm OK with them.
Acked-by: Xu Yilun <yilun.xu@intel.com>
Applied.
>
> Thanks,
> Marco
>
> [...]
>
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2023-07-10 8:08 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-06 14:27 [RFC PATCH 0/2] fpga: fix kernel-doc warnings and align descriptions for the core components Marco Pagani
2023-07-06 14:27 ` [RFC PATCH 1/2] fpga: region: fix kernel-doc Marco Pagani
2023-07-06 21:30 ` Randy Dunlap
2023-07-10 8:05 ` Xu Yilun
2023-07-06 14:27 ` [RFC PATCH 2/2] fpga: bridge: " Marco Pagani
2023-07-06 21:35 ` Randy Dunlap
2023-07-06 21:37 ` Randy Dunlap
2023-07-07 8:50 ` Marco Pagani
2023-07-10 8:06 ` Xu Yilun
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.