From: Peter Colberg <peter.colberg@intel.com>
To: Wu Hao <hao.wu@intel.com>, Tom Rix <trix@redhat.com>,
Moritz Fischer <mdf@kernel.org>, Xu Yilun <yilun.xu@intel.com>,
Alan Tull <atull@kernel.org>, Shiva Rao <shiva.rao@intel.com>,
Kang Luwei <luwei.kang@intel.com>,
Enno Luebbers <enno.luebbers@intel.com>,
linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Russ Weight <russ.weight@linux.dev>,
Marco Pagani <marpagan@redhat.com>,
Matthew Gerlach <matthew.gerlach@linux.intel.com>,
kernel test robot <lkp@intel.com>,
Peter Colberg <peter.colberg@intel.com>
Subject: [PATCH v2] fpga: dfl: fme: revise kernel-doc comments for some functions
Date: Tue, 2 Apr 2024 16:47:43 -0400 [thread overview]
Message-ID: <20240402204743.1069624-1-peter.colberg@intel.com> (raw)
From: Xu Yilun <yilun.xu@intel.com>
This amends commit 782d8e61b5d6 ("fpga: dfl: kernel-doc corrections"),
which separately addressed the kernel-doc warnings below. Add a more
precise description of the feature argument to dfl_fme_create_mgr(),
and also use plural in the description of dfl_fme_destroy_bridges().
lkp reported 2 build warnings:
drivers/fpga/dfl/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr'
>> drivers/fpga/dfl/dfl-fme-pr.c:280: warning: expecting prototype for
>> dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges()
>> instead
Fixes: 29de76240e86 ("fpga: dfl: fme: add partial reconfiguration sub feature support")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Xu Yilun <yilun.xu@intel.com>
Signed-off-by: Peter Colberg <peter.colberg@intel.com>
---
v2:
- Correctly rebase patch onto commit 782d8e61b5d6.
---
drivers/fpga/dfl-fme-pr.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c
index cdcf6dea4cc9..b66f2c1e10a9 100644
--- a/drivers/fpga/dfl-fme-pr.c
+++ b/drivers/fpga/dfl-fme-pr.c
@@ -164,7 +164,7 @@ static int fme_pr(struct platform_device *pdev, unsigned long arg)
/**
* dfl_fme_create_mgr - create fpga mgr platform device as child device
- * @feature: sub feature info
+ * @feature: the dfl fme PR sub feature
* @pdata: fme platform_device's pdata
*
* Return: mgr platform device if successful, and error code otherwise.
@@ -273,7 +273,7 @@ static void dfl_fme_destroy_bridge(struct dfl_fme_bridge *fme_br)
}
/**
- * dfl_fme_destroy_bridges - destroy all fpga bridge platform device
+ * dfl_fme_destroy_bridges - destroy all fpga bridge platform devices
* @pdata: fme platform device's pdata
*/
static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
--
2.44.0
next reply other threads:[~2024-04-02 20:47 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-02 20:47 Peter Colberg [this message]
2024-04-09 3:39 ` [PATCH v2] fpga: dfl: fme: revise kernel-doc comments for some functions Xu Yilun
2024-04-09 18:30 ` Colberg, Peter
2024-04-10 5:05 ` Xu Yilun
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=20240402204743.1069624-1-peter.colberg@intel.com \
--to=peter.colberg@intel.com \
--cc=atull@kernel.org \
--cc=enno.luebbers@intel.com \
--cc=hao.wu@intel.com \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=luwei.kang@intel.com \
--cc=marpagan@redhat.com \
--cc=matthew.gerlach@linux.intel.com \
--cc=mdf@kernel.org \
--cc=russ.weight@linux.dev \
--cc=shiva.rao@intel.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 read-only IMAP folder(s) and NNTP newsgroup(s).