| Message ID | 20230330174505.158920-1-marpagan@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: bridge: fix kernel-doc | expand |
On 2023-03-30 at 19:45:05 +0200, 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' 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. > > 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
On 2023-04-02 08:36, Xu Yilun wrote: > On 2023-03-30 at 19:45:05 +0200, 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' > > 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. >> >> 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/20230301140309.512578-1-marpagan@redhat.com/ That has been applied to char-misc-next: https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/char-misc.git/commit/drivers/fpga/fpga-bridge.c?h=char-misc-next&id=7ef1a2c1c9dffa177ecc3ea50b7f5ee63a621137 Thanks, Marco
diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c index ff4470067ed5..adb4a79a1b11 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. */ 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,
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"). Signed-off-by: Marco Pagani <marpagan@redhat.com> --- drivers/fpga/fpga-bridge.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)