All of lore.kernel.org
 help / color / mirror / Atom feed
From: alexs@kernel.org
To: unlisted-recipients:; (no To-header on input)
Cc: Alex Shi <alexs@kernel.org>,
	Alexander Viro <viro@zeniv.linux.org.uk>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org
Subject: [PATCH] iov_iter: fix kernel-doc comments issues
Date: Mon,  5 Apr 2021 22:05:38 +0800	[thread overview]
Message-ID: <20210405140538.132791-1-alexs@kernel.org> (raw)

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


                 reply	other threads:[~2021-04-05 14:05 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20210405140538.132791-1-alexs@kernel.org \
    --to=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=viro@zeniv.linux.org.uk \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.