From: Stephen Boyd <stephen.boyd@linaro.org>
To: linux-mm@kvack.org
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] mm/maccess.c: Fix up kernel doc notation
Date: Thu, 16 Feb 2017 11:32:51 -0800 [thread overview]
Message-ID: <20170216193251.20242-1-stephen.boyd@linaro.org> (raw)
One argument was incorrect, two functions weren't showing the
brief description, and the docs for strncpy_from_unsafe() had a
colon attached to it. Fix it up.
Cc: <linux-doc@vger.kernel.org>
Signed-off-by: Stephen Boyd <stephen.boyd@linaro.org>
---
mm/maccess.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/mm/maccess.c b/mm/maccess.c
index 78f9274dd49d..ee305aa22535 100644
--- a/mm/maccess.c
+++ b/mm/maccess.c
@@ -6,7 +6,7 @@
#include <linux/uaccess.h>
/**
- * probe_kernel_read(): safely attempt to read from a location
+ * probe_kernel_read() - safely attempt to read from a location.
* @dst: pointer to the buffer that shall take the data
* @src: address to read from
* @size: size of the data chunk
@@ -40,7 +40,7 @@ long __probe_kernel_read(void *dst, const void *src, size_t size)
EXPORT_SYMBOL_GPL(probe_kernel_read);
/**
- * probe_kernel_write(): safely attempt to write to a location
+ * probe_kernel_write() - safely attempt to write to a location.
* @dst: address to write to
* @src: pointer to the data that shall be written
* @size: size of the data chunk
@@ -67,10 +67,10 @@ long __probe_kernel_write(void *dst, const void *src, size_t size)
EXPORT_SYMBOL_GPL(probe_kernel_write);
/**
- * strncpy_from_unsafe: - Copy a NUL terminated string from unsafe address.
+ * strncpy_from_unsafe() - Copy a NUL terminated string from unsafe address.
* @dst: Destination address, in kernel space. This buffer must be at
* least @count bytes long.
- * @src: Unsafe address.
+ * @unsafe_addr: Unsafe address.
* @count: Maximum number of bytes to copy, including the trailing NUL.
*
* Copies a NUL-terminated string from unsafe address to kernel buffer.
--
2.10.0.297.gf6727b0
--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org. For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>
reply other threads:[~2017-02-16 19:32 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=20170216193251.20242-1-stephen.boyd@linaro.org \
--to=stephen.boyd@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.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;
as well as URLs for NNTP newsgroup(s).