From: Randy Dunlap <rdunlap@infradead.org>
To: Nava kishore Manne <nava.manne@xilinx.com>,
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
Subject: Re: [PATCH 6/6] fpga: fpga-region: Add missing kernel-doc description
Date: Tue, 8 Mar 2022 13:40:06 -0800 [thread overview]
Message-ID: <6d3bca5e-00d7-3a69-4f90-809f4aac95d5@infradead.org> (raw)
In-Reply-To: <20220308094519.1816649-7-nava.manne@xilinx.com>
Hi,
For all function return results,
s/@return:/Return:/
thanks.
On 3/8/22 01:45, Nava kishore Manne wrote:
> Fixed the warnings: Function parameter or member 'xxx' not
> described.
>
> Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> ---
> drivers/fpga/of-fpga-region.c | 18 ++++++++++--------
> 1 file changed, 10 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/fpga/of-fpga-region.c b/drivers/fpga/of-fpga-region.c
> index 50b83057c048..61ce257c47f3 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)
> {
> @@ -43,7 +43,7 @@ static struct fpga_region *of_fpga_region_find(struct device_node *np)
> *
> * Caller should call fpga_mgr_put() when done with manager.
> *
> - * Return: fpga manager struct or IS_ERR() condition containing error code.
> + * @return: fpga manager struct or IS_ERR() condition containing error code.
> */
> static struct fpga_manager *of_fpga_region_get_mgr(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)
> {
--
~Randy
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
prev parent reply other threads:[~2022-03-08 21:41 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-08 9:45 [PATCH 0/6]fpga: fix for coding style and kernel-doc issues Nava kishore Manne
2022-03-08 9:45 ` [PATCH 1/6] fpga: zynq: Fix incorrect variable type Nava kishore Manne
2022-03-08 9:45 ` [PATCH 2/6] fpga: zynqmp: Initialized variables before using it Nava kishore Manne
2022-03-11 14:28 ` Xu Yilun
2022-03-15 11:48 ` Nava kishore Manne
2022-03-15 16:08 ` Xu Yilun
2022-03-22 6:55 ` Nava kishore Manne
2022-03-08 9:45 ` [PATCH 3/6] fpga: fpga-mgr: fix for coding style issues Nava kishore Manne
2022-03-08 9:45 ` [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description Nava kishore Manne
2022-03-08 21:38 ` Randy Dunlap
2022-03-15 11:51 ` Nava kishore Manne
2022-03-08 9:45 ` [PATCH 5/6] fpga: Use tab instead of spaces for indentation Nava kishore Manne
2022-03-08 9:45 ` [PATCH 6/6] fpga: fpga-region: Add missing kernel-doc description Nava kishore Manne
2022-03-08 21:40 ` Randy Dunlap [this message]
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=6d3bca5e-00d7-3a69-4f90-809f4aac95d5@infradead.org \
--to=rdunlap@infradead.org \
--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=nava.manne@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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).