Thread (14 messages) 14 messages, 4 authors, 2022-03-22

RE: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description

From: Nava kishore Manne <hidden>
Date: 2022-03-15 11:52:08
Also in: linux-fpga, lkml

Hi Randy,

	Thanks for providing the review comments.
Please find response inline.
-----Original Message-----
From: Randy Dunlap <redacted>
Sent: Wednesday, March 9, 2022 3:09 AM
To: Nava kishore Manne <redacted>; mdf@kernel.org;
hao.wu@intel.com; yilun.xu@intel.com; trix@redhat.com; Michal Simek
[off-list ref]; linux-fpga@vger.kernel.org; linux-
kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description

Hi--

On 3/8/22 01:45, Nava kishore Manne wrote:
quoted
Fixed the warnings: Function parameter or member 'xxx' not described.

Signed-off-by: Nava kishore Manne <redacted>
---
 drivers/fpga/fpga-mgr.c | 4 ++++
 1 file changed, 4 insertions(+)
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c index
a699cc8e2fa6..354789740529 100644
--- a/drivers/fpga/fpga-mgr.c
+++ b/drivers/fpga/fpga-mgr.c
@@ -730,6 +730,8 @@ static void devm_fpga_mgr_unregister(struct
device *dev, void *res)
quoted
  * @parent:	fpga manager device from pdev
  * @info:	parameters for fpga manager
  *
+ * @return:  fpga manager pointer on success, negative error code
otherwise.

Not quite. Should be:

 * Return: foo bar blah
Will fix in v2
quoted
+ *
  * This is the devres variant of fpga_mgr_register_full() for which the
unregister
quoted
  * function will be called automatically when the managing device is
detached.
quoted
  */
@@ -763,6 +765,8 @@
EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);
quoted
  * @mops:	pointer to structure of fpga manager ops
  * @priv:	fpga manager private data
  *
+ * @return:  fpga manager pointer on success, negative error code
otherwise.

ditto.
Will fix in v2.

Regards,
Navakishore.
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help