From: Nava kishore Manne <nava.manne@xilinx.com> To: <mdf@kernel.org>, <hao.wu@intel.com>, <yilun.xu@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> Cc: Nava kishore Manne <nava.manne@xilinx.com> Subject: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc description Date: Sun, 3 Apr 2022 10:46:41 +0530 [thread overview] Message-ID: <20220403051641.3867610-6-nava.manne@xilinx.com> (raw) In-Reply-To: <20220403051641.3867610-1-nava.manne@xilinx.com> Fixed the warnings: No description found for return value of 'xxx' Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> --- Changes for v2: -Replaced s/@return:/Return:/ Changes for v3: -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
WARNING: multiple messages have this Message-ID (diff)
From: Nava kishore Manne <nava.manne@xilinx.com> To: <mdf@kernel.org>, <hao.wu@intel.com>, <yilun.xu@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> Cc: Nava kishore Manne <nava.manne@xilinx.com> Subject: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc description Date: Sun, 3 Apr 2022 10:46:41 +0530 [thread overview] Message-ID: <20220403051641.3867610-6-nava.manne@xilinx.com> (raw) In-Reply-To: <20220403051641.3867610-1-nava.manne@xilinx.com> Fixed the warnings: No description found for return value of 'xxx' Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> --- Changes for v2: -Replaced s/@return:/Return:/ Changes for v3: -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
next prev parent reply other threads:[~2022-04-03 5:17 UTC|newest] Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-04-03 5:16 [PATCH v3 0/5]fpga: fix for coding style and kernel-doc issues Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne 2022-04-03 5:16 ` [PATCH v3 1/5] fpga: zynq: Fix incorrect variable type Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne 2022-04-03 8:11 ` kernel test robot 2022-04-05 4:38 ` Xu Yilun 2022-04-05 4:38 ` Xu Yilun 2022-04-05 16:00 ` Russ Weight 2022-04-05 16:00 ` Russ Weight 2022-04-03 5:16 ` [PATCH v3 2/5] fpga: fix for coding style issues Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne 2022-04-03 5:16 ` [PATCH v3 3/5] fpga: fpga-mgr: Add missing kernel-doc description Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne 2022-04-03 5:16 ` [PATCH v3 4/5] fpga: Use tab instead of space indentation Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne 2022-04-03 5:16 ` Nava kishore Manne [this message] 2022-04-03 5:16 ` [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc description Nava kishore Manne 2022-04-05 5:35 ` Xu Yilun 2022-04-05 5:35 ` Xu Yilun 2022-04-07 5:31 ` Nava kishore Manne 2022-04-07 5:31 ` Nava kishore Manne 2022-04-07 6:48 ` Xu Yilun 2022-04-07 6:48 ` Xu Yilun 2022-04-16 13:18 ` Nava kishore Manne 2022-04-16 13:18 ` Nava kishore Manne 2022-04-03 13:05 [PATCH v3 1/5] fpga: zynq: Fix incorrect variable type kernel test robot 2022-04-04 13:49 ` Dan Carpenter
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20220403051641.3867610-6-nava.manne@xilinx.com \ --to=nava.manne@xilinx.com \ --cc=git@xilinx.com \ --cc=hao.wu@intel.com \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-fpga@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mdf@kernel.org \ --cc=michal.simek@xilinx.com \ --cc=trix@redhat.com \ --cc=yilun.xu@intel.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.