| Message ID | 20220322082202.2007321-4-nava.manne@xilinx.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: fix for coding style and kernel-doc issues | expand |
On 3/22/22 1:22 AM, Nava kishore Manne wrote: > Fixed the warnings: Function parameter or member 'xxx' not > described. How were the warnings generated ? Tom > > Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> > --- > Changes for v2: > -Replaced s/@return:/Return:/ > > 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..0f2b28538f17 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) > * @parent: fpga manager device from pdev > * @info: parameters for fpga manager > * > + * Return: fpga manager pointer on success, negative error code otherwise. > + * > * This is the devres variant of fpga_mgr_register_full() for which the unregister > * function will be called automatically when the managing device is detached. > */ > @@ -763,6 +765,8 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full); > * @mops: pointer to structure of fpga manager ops > * @priv: fpga manager private data > * > + * Return: fpga manager pointer on success, negative error code otherwise. > + * > * This is the devres variant of fpga_mgr_register() for which the > * unregister function will be called automatically when the managing > * device is detached.
Hi Tom, Thanks for providing the review comments. Please find my response inline. > -----Original Message----- > From: Tom Rix <trix@redhat.com> > Sent: Saturday, March 26, 2022 10:36 PM > To: Nava kishore Manne <navam@xilinx.com>; mdf@kernel.org; > hao.wu@intel.com; yilun.xu@intel.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 v2 3/5] fpga: fpga-mgr: Add missing kernel-doc > description > > > On 3/22/22 1:22 AM, Nava kishore Manne wrote: > > Fixed the warnings: Function parameter or member 'xxx' not described. > > How were the warnings generated ? > I Will update the commit message in v3. Regards, Navakishore.
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c index a699cc8e2fa6..0f2b28538f17 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) * @parent: fpga manager device from pdev * @info: parameters for fpga manager * + * Return: fpga manager pointer on success, negative error code otherwise. + * * This is the devres variant of fpga_mgr_register_full() for which the unregister * function will be called automatically when the managing device is detached. */ @@ -763,6 +765,8 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full); * @mops: pointer to structure of fpga manager ops * @priv: fpga manager private data * + * Return: fpga manager pointer on success, negative error code otherwise. + * * This is the devres variant of fpga_mgr_register() for which the * unregister function will be called automatically when the managing * device is detached.
Fixed the warnings: Function parameter or member 'xxx' not described. Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> --- Changes for v2: -Replaced s/@return:/Return:/ drivers/fpga/fpga-mgr.c | 4 ++++ 1 file changed, 4 insertions(+)