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@xxxxxxxxxx>
> ---
> 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@xxxxxxxxxxxxx>
> *
> - * 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
