linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Wang Wenhu <wenhu.wang@vivo.com>
To: Andrew Morton <akpm@linux-foundation.org>,
	linux-mm@kvack.org, linux-kernel@vger.kernel.org
Cc: trivial@kernel.org, kernel@vivo.com, Wang Wenhu <wenhu.wang@vivo.com>
Subject: [PATCH] mm: clarify a confusing comment for vm_iomap_memory
Date: Tue, 17 Mar 2020 22:22:06 -0700	[thread overview]
Message-ID: <20200318052206.105104-1-wenhu.wang@vivo.com> (raw)

The param "start" actually referes to the physical memory start,
which is to be mapped into virtual area vma. And it is the field
vma->vm_start which stands for the start of the area.

Most of the time, we do not read through whole implementation
of a function but only the definition and essential comments.
Accurate comments are definitely the base stone.

Signed-off-by: Wang Wenhu <wenhu.wang@vivo.com>
---
 mm/memory.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/memory.c b/mm/memory.c
index 583f84519870..5c356a57b892 100644
--- a/mm/memory.c
+++ b/mm/memory.c
@@ -2009,7 +2009,7 @@ EXPORT_SYMBOL(remap_pfn_range);
 /**
  * vm_iomap_memory - remap memory to userspace
  * @vma: user vma to map to
- * @start: start of area
+ * @start: start of the physical memory to be mapped
  * @len: size of area
  *
  * This is a simplified io_remap_pfn_range() for common driver use. The
-- 
2.17.1



                 reply	other threads:[~2020-03-18  5:22 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=20200318052206.105104-1-wenhu.wang@vivo.com \
    --to=wenhu.wang@vivo.com \
    --cc=akpm@linux-foundation.org \
    --cc=kernel@vivo.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=trivial@kernel.org \
    /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