| Message ID | 20220416133719.3382895-4-nava.manne@xilinx.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: fix for coding style and kernel-doc issues | expand |
On Sat, Apr 16, 2022 at 07:07:17PM +0530, Nava kishore Manne wrote: > warnings: No description found for return value of 'xxx' > > In-order to fix the above kernel-doc warnings added the > 'Return' description for 'devm_fpga_mgr_register_full()' > and 'devm_fpga_mgr_register()' API's. APIs. > > Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> With the minor fix, please add my Acked-by. Acked-by: Xu Yilun <yilun.xu@intel.com> > --- > Changes for v2: > -Replaced s/@return:/Return:/ > Changes for v3: > -Updated commit description. > Changes for v4: > -Updated commit description. > > 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. > -- > 2.25.1
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.
warnings: No description found for return value of 'xxx' In-order to fix the above kernel-doc warnings added the 'Return' description for 'devm_fpga_mgr_register_full()' and 'devm_fpga_mgr_register()' API's. Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com> --- Changes for v2: -Replaced s/@return:/Return:/ Changes for v3: -Updated commit description. Changes for v4: -Updated commit description. drivers/fpga/fpga-mgr.c | 4 ++++ 1 file changed, 4 insertions(+)