fpga: bridge: fix kernel-doc
PATCH 1/1 fpga: bridge: fix kernel-doc
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'
The patch is based on top of 38dbcd697770 ("fpga: bridge: fix kernel-doc parameter description").
--- drivers/fpga/fpga-bridge.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
drivers/fpga/fpga-bridge.c +12 -11
@@ -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. */ 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; 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; 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,
Signature · 1 line
2.39.2
Xu Yilun
maintainerQuoted 7 lines · Marco Pagani
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'
I see you are trying to clean up the warnings, but I found more in drivers/fpga. Could you help at least fix all core code, (of-)fpga-bridge/region/mgr.c/h in series? Thanks.
Quoted 2 lines
The patch is based on top of
38dbcd697770("fpga: bridge: fix kernel-doc parameter description").
I didn't found this commit, could you elaborate? And you could put this info in changelog, don't show it up in mainline.
Thanks,
Yilun
Quoted 9 lines · Xu Yilun
Quoted 7 lines · Marco Pagani
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'
Quoted 4 lines
I see you are trying to clean up the warnings, but I found more in
drivers/fpga. Could you help at least fix all core code, (of-)fpga-bridge/region/mgr.c/h in series? Thanks.
Sure, I'll do it.
Quoted 6 lines
Quoted 2 lines
The patch is based on top of
38dbcd697770("fpga: bridge: fix kernel-doc parameter description").I didn't found this commit, could you elaborate? And you could put this info in changelog, don't show it up in mainline.
Sorry, I accidentally put the wrong hash. I was referring to this patch:
https://lore.kernel.org/linux-fpga/[email protected]/
That has been applied to char-misc-next:
Thanks,
Marco