mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] iov_iter: fix kernel-doc comments issues
@ 2021-04-05 14:05 alexs
  0 siblings, 0 replies; only message in thread
From: alexs @ 2021-04-05 14:05 UTC (permalink / raw)
  Cc: Alex Shi, Alexander Viro, Jonathan Corbet, linux-kernel

From: Alex Shi <alexs@kernel.org>

There are some issues of kernel-doc comments:
lib/iov_iter.c:752: warning: Function parameter or member 'i' not described in '_copy_mc_to_iter'
lib/iov_iter.c:752: warning: Excess function parameter 'iter' description in '_copy_mc_to_iter'
lib/iov_iter.c:886: warning: Function parameter or member 'i' not described in '_copy_from_iter_flushcache'
lib/iov_iter.c:886: warning: Excess function parameter 'iter' description in '_copy_from_iter_flushcache'

correct the 'iter' in comments to 'i' to fix this.

Signed-off-by: Alex Shi <alexs@kernel.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk> 
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-kernel@vger.kernel.org 
---
 lib/iov_iter.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/iov_iter.c b/lib/iov_iter.c
index 2ace486824f4..7cda61e6b467 100644
--- a/lib/iov_iter.c
+++ b/lib/iov_iter.c
@@ -729,7 +729,7 @@ static size_t copy_mc_pipe_to_iter(const void *addr, size_t bytes,
  * _copy_mc_to_iter - copy to iter with source memory error exception handling
  * @addr: source kernel address
  * @bytes: total transfer length
- * @iter: destination iterator
+ * @i: destination iterator
  *
  * The pmem driver deploys this for the dax operation
  * (dax_copy_to_iter()) for dax reads (bypass page-cache and the
@@ -872,7 +872,7 @@ EXPORT_SYMBOL(_copy_from_iter_nocache);
  * _copy_from_iter_flushcache - write destination through cpu cache
  * @addr: destination kernel address
  * @bytes: total transfer length
- * @iter: source iterator
+ * @i: source iterator
  *
  * The pmem driver arranges for filesystem-dax to use this facility via
  * dax_copy_from_iter() for ensuring that writes to persistent memory
-- 
2.25.1


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-04-05 14:05 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-05 14:05 [PATCH] iov_iter: fix kernel-doc comments issues alexs

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®