From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id EDB13EB64D9 for ; Thu, 6 Jul 2023 21:35:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231895AbjGFVfG (ORCPT ); Thu, 6 Jul 2023 17:35:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57632 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229741AbjGFVfE (ORCPT ); Thu, 6 Jul 2023 17:35:04 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7EEE9FF; Thu, 6 Jul 2023 14:35:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=apsCx/EFeWwzyiurRwGIOaRvS2oRweRFYfEbIucCThs=; b=0ZyvmHn+DDaqx7mvnrogE4Cr/w SAtw+zEGo/6Tha7aickmvvUzoJGLHMXWwrjp4IIWaYxV4W/f4vrbaOYIJ44L71v8f41cHr+66oxBP 64uFad5GiPzj3G+HhteUbp8XHP8YYANrdI5aeFIwFIfpnDg+z2YbXVLjpF/MLfws0ypPJ78F8ekgg erK90oEN3Tj3oeijHKc7aXzh5UC9q/CBympsQ9zEKYiDHw/pKDACsHANCd2ZJyC2MjEugDXdN66Ci OHEWqyvaG9vbTLDsE39XkcrcFf8DCLnLgCFdRgxJ5Wf+7uwm+7EY3KyEk9YnAicfjMvlS/nLXM5xN AV+Kjjnw==; Received: from [2601:1c2:980:9ec0::2764] by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qHWcu-002k0y-2E; Thu, 06 Jul 2023 21:35:00 +0000 Message-ID: Date: Thu, 6 Jul 2023 14:35:00 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.12.0 Subject: Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc Content-Language: en-US To: Marco Pagani , Moritz Fischer , Wu Hao , Xu Yilun , Tom Rix Cc: linux-kernel@vger.kernel.org, linux-fpga@vger.kernel.org References: <20230706142755.124879-1-marpagan@redhat.com> <20230706142755.124879-3-marpagan@redhat.com> From: Randy Dunlap In-Reply-To: <20230706142755.124879-3-marpagan@redhat.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > --- > 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 > * > - * 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