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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 9A1BEC433EF for ; Sat, 16 Apr 2022 16:50:20 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=41xZ6nrOGytSAVeHNs+WA2iOYAJ0BQQYnqgioue3pU0=; b=qKmc+Hb8zVS7z+ eXj2Go9HxIhC030cP2L4sM0PUQx3oltdpgSnhPpx5K+5sug6OJHbktOAUyb7KyJ92wLZoGQPPhfMM Hg9f7VsJD7kM4IGTBzxpVjzHfG07Gn5xxCVQtbmP+x29vM59nnHtzErvlNAxIpc/T9XzyDnF1NsWM mChSOIOP8XqspRsOG6XMf1MhWLKebCJOPiOgk9xxFYNkijpVQV5wyNsASbMKqG6Em9D3nJkRk3c84 b+UOLvNwO0Sp9S2+IlQ0mJJFJHzb9CtXZNH2N2pH8STh2umkwuGqiCQ7TkEveg/PVMnV0lbdTqcY7 l9BDy51vYRF0cvm2wKnQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1nflbb-00DFmc-BD; Sat, 16 Apr 2022 16:49:03 +0000 Received: from mga09.intel.com ([134.134.136.24]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1nflbY-00DFmA-BV for linux-arm-kernel@lists.infradead.org; Sat, 16 Apr 2022 16:49:02 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1650127740; x=1681663740; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=FRSApa93qf26an3ztDlnFEZ03B94VG7Q1j0FckBB3sg=; b=GGCiEbFESpnVXAcaik/Ol3jdGIUvb+JZLOG3XQ+muGMcUzN/Es5Vp1TH d3MxVp7YZnIZ4kIxnYdng+EoeU3bV3DvVLzDXQBaiB5a9B0t3RbHM+u9B BSPZ7JPYZNX9TsRYv/c4dMk4jO1fhtUg5uR6HOSA1PxthuBq/lMualCuz HqHL1uMZNHVdjlLEo2qMiIQjzY1MqxXD+iP6ttrMTC3PdJVYuc+Lz/wRI a2O5nKQEP9LN3bEmbF53imgIKlOWAVYMVcrDKEvXO/GQsJROMQbd9FUtL 2f/zuckOEFpHb9XzWZcXYdSXAAfscyq5pGo44SPKxHIBTCqxBTsKTRbv0 g==; X-IronPort-AV: E=McAfee;i="6400,9594,10318"; a="262766627" X-IronPort-AV: E=Sophos;i="5.90,264,1643702400"; d="scan'208";a="262766627" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Apr 2022 09:48:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,264,1643702400"; d="scan'208";a="574878515" Received: from yilunxu-optiplex-7050.sh.intel.com (HELO localhost) ([10.239.159.135]) by orsmga008.jf.intel.com with ESMTP; 16 Apr 2022 09:48:54 -0700 Date: Sun, 17 Apr 2022 00:41:23 +0800 From: Xu Yilun To: Nava kishore Manne Cc: mdf@kernel.org, hao.wu@intel.com, trix@redhat.com, michal.simek@xilinx.com, linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, git@xilinx.com Subject: Re: [PATCH v4 5/5] fpga: fpga-region: fix kernel-doc formatting issues Message-ID: <20220416164123.GE301222@yilunxu-OptiPlex-7050> References: <20220416133719.3382895-1-nava.manne@xilinx.com> <20220416133719.3382895-6-nava.manne@xilinx.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20220416133719.3382895-6-nava.manne@xilinx.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220416_094900_503617_3DAAB9B5 X-CRM114-Status: GOOD ( 25.24 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Sat, Apr 16, 2022 at 07:07:19PM +0530, Nava kishore Manne wrote: > To fix below kernel-doc warnings this patch does the following > ->Replaced Return\Returns with 'Return:' keyword. > ->Added 'Return' description For __init of_fpga_region_init()' API. > ->Added description for 'child_regions_with_firmware()' API. > > warning: No description found for return value of > 'of_fpga_region_find'. > warning: No description found for return value of > 'of_fpga_region_get_bridges'. > warning: missing initial short description on line: > * child_regions_with_firmware > warning: No description found for return value of > 'child_regions_with_firmware'. > warning: No description found for return value of > 'of_fpga_region_notify_pre_apply'. > warning: No description found for return value of > 'of_fpga_region_notify'. > warning: No description found for return value of > 'of_fpga_region_init'. > > Signed-off-by: Nava kishore Manne Acked-by: Xu Yilun > --- > Changes for v2: > -Replaced s/@return:/Return:/ > Changes for v3: > -Updated commit description. > Changes for v4: > -Updated commit description. > > drivers/fpga/of-fpga-region.c | 16 +++++++++------- > 1 file changed, 9 insertions(+), 7 deletions(-) > > diff --git a/drivers/fpga/of-fpga-region.c b/drivers/fpga/of-fpga-region.c > index 50b83057c048..9e330a2c0a1b 100644 > --- a/drivers/fpga/of-fpga-region.c > +++ b/drivers/fpga/of-fpga-region.c > @@ -28,7 +28,7 @@ MODULE_DEVICE_TABLE(of, fpga_region_of_match); > * > * Caller will need to put_device(®ion->dev) when done. > * > - * Returns FPGA Region struct or NULL > + * Return: FPGA Region struct or NULL > */ > static struct fpga_region *of_fpga_region_find(struct device_node *np) > { > @@ -80,7 +80,7 @@ static struct fpga_manager *of_fpga_region_get_mgr(struct device_node *np) > * Caller should call fpga_bridges_put(®ion->bridge_list) when > * done with the bridges. > * > - * Return 0 for success (even if there are no bridges specified) > + * Return: 0 for success (even if there are no bridges specified) > * or -EBUSY if any of the bridges are in use. > */ > static int of_fpga_region_get_bridges(struct fpga_region *region) > @@ -139,13 +139,13 @@ static int of_fpga_region_get_bridges(struct fpga_region *region) > } > > /** > - * child_regions_with_firmware > + * child_regions_with_firmware - Used to check the child region info. > * @overlay: device node of the overlay > * > * If the overlay adds child FPGA regions, they are not allowed to have > * firmware-name property. > * > - * Return 0 for OK or -EINVAL if child FPGA region adds firmware-name. > + * Return: 0 for OK or -EINVAL if child FPGA region adds firmware-name. > */ > static int child_regions_with_firmware(struct device_node *overlay) > { > @@ -184,7 +184,7 @@ static int child_regions_with_firmware(struct device_node *overlay) > * Given an overlay applied to an FPGA region, parse the FPGA image specific > * info in the overlay and do some checking. > * > - * Returns: > + * Return: > * NULL if overlay doesn't direct us to program the FPGA. > * fpga_image_info struct if there is an image to program. > * error code for invalid overlay. > @@ -279,7 +279,7 @@ static struct fpga_image_info *of_fpga_region_parse_ov( > * If the checks fail, overlay is rejected and does not get added to the > * live tree. > * > - * Returns 0 for success or negative error code for failure. > + * Return: 0 for success or negative error code for failure. > */ > static int of_fpga_region_notify_pre_apply(struct fpga_region *region, > struct of_overlay_notify_data *nd) > @@ -339,7 +339,7 @@ static void of_fpga_region_notify_post_remove(struct fpga_region *region, > * This notifier handles programming an FPGA when a "firmware-name" property is > * added to an fpga-region. > * > - * Returns NOTIFY_OK or error if FPGA programming fails. > + * Return: NOTIFY_OK or error if FPGA programming fails. > */ > static int of_fpga_region_notify(struct notifier_block *nb, > unsigned long action, void *arg) > @@ -446,6 +446,8 @@ static struct platform_driver of_fpga_region_driver = { > /** > * of_fpga_region_init - init function for fpga_region class > * Creates the fpga_region class and registers a reconfig notifier. > + * > + * Return: 0 on success, negative error code otherwise. > */ > static int __init of_fpga_region_init(void) > { > -- > 2.25.1 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel