| Message ID | 20220403051641.3867610-6-nava.manne@xilinx.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: fix for coding style and kernel-doc issues | expand |
On Sun, Apr 03, 2022 at 10:46:41AM +0530, Nava kishore Manne wrote: > Fixed the warnings: No description found for return value of 'xxx' The commit message is not clear. There are descriptions for some functions, but not in right format. Thanks, Yilun > > 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
Hi Yilun, Thanks for providing the review comments. Please find my response inline. > -----Original Message----- > From: Xu Yilun <yilun.xu@intel.com> > Sent: Tuesday, April 5, 2022 11:06 AM > To: Nava kishore Manne <navam@xilinx.com> > Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek > <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux- > kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git > <git@xilinx.com> > Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc > description > > On Sun, Apr 03, 2022 at 10:46:41AM +0530, Nava kishore Manne wrote: > > Fixed the warnings: No description found for return value of 'xxx' > > The commit message is not clear. There are descriptions for some functions, > but not in right format. > I agree for some functions has description but not in the right format. The "Description Not exits" and "Description not in the right format" in both cases the tool will report the same warning ie; " warnings: No description found for return value of 'xxx'" This patch address the above warning. So to make it relevant I have added the same in the commit msg. Regards, Navakishore.
On Thu, Apr 07, 2022 at 05:31:39AM +0000, Nava kishore Manne wrote: > Hi Yilun, > > Thanks for providing the review comments. > Please find my response inline. > > > -----Original Message----- > > From: Xu Yilun <yilun.xu@intel.com> > > Sent: Tuesday, April 5, 2022 11:06 AM > > To: Nava kishore Manne <navam@xilinx.com> > > Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek > > <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux- > > kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git > > <git@xilinx.com> > > Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc > > description > > > > On Sun, Apr 03, 2022 at 10:46:41AM +0530, Nava kishore Manne wrote: > > > Fixed the warnings: No description found for return value of 'xxx' > > > > The commit message is not clear. There are descriptions for some functions, > > but not in right format. > > > I agree for some functions has description but not in the right format. > The "Description Not exits" and "Description not in the right format" in both cases the tool will report the same warning ie; " warnings: No description found for return value of 'xxx'" Thanks for the info. It would be better we describe the root cause in commit message along with the robot reports. And also change the subject please. > This patch address the above warning. So to make it relevant I have added the same in the commit msg. Adding the same commit message may not be a good way, for this case you could just combine them into one commit. Thanks, Yilun > > Regards, > Navakishore.
Hi Yilun, > -----Original Message----- > From: Xu Yilun <yilun.xu@intel.com> > Sent: Thursday, April 7, 2022 12:18 PM > To: Nava kishore Manne <navam@xilinx.com> > Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek > <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux- > kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git > <git@xilinx.com> > Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing kernel-doc > description > > On Thu, Apr 07, 2022 at 05:31:39AM +0000, Nava kishore Manne wrote: > > Hi Yilun, > > > > Thanks for providing the review comments. > > Please find my response inline. > > > > > -----Original Message----- > > > From: Xu Yilun <yilun.xu@intel.com> > > > Sent: Tuesday, April 5, 2022 11:06 AM > > > To: Nava kishore Manne <navam@xilinx.com> > > > Cc: mdf@kernel.org; hao.wu@intel.com; trix@redhat.com; Michal Simek > > > <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux- > > > kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; git > > > <git@xilinx.com> > > > Subject: Re: [PATCH v3 5/5] fpga: fpga-region: Add missing > > > kernel-doc description > > > > > > On Sun, Apr 03, 2022 at 10:46:41AM +0530, Nava kishore Manne wrote: > > > > Fixed the warnings: No description found for return value of 'xxx' > > > > > > The commit message is not clear. There are descriptions for some > > > functions, but not in right format. > > > > > I agree for some functions has description but not in the right format. > > The "Description Not exits" and "Description not in the right format" in > both cases the tool will report the same warning ie; " warnings: No > description found for return value of 'xxx'" > > Thanks for the info. It would be better we describe the root cause in commit > message along with the robot reports. > > And also change the subject please. > Will fix > > This patch address the above warning. So to make it relevant I have added > the same in the commit msg. > > Adding the same commit message may not be a good way, for this case you > could just combine them into one commit. > Will fix. Regards, Navakishore.
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) {
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(-)