LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input
@ 2021-07-19 12:20 Andy Shevchenko
  2021-07-19 12:44 ` Matthew Wilcox
  0 siblings, 1 reply; 3+ messages in thread
From: Andy Shevchenko @ 2021-07-19 12:20 UTC (permalink / raw)
  To: linux-mm, linux-kernel; +Cc: Andrew Morton, Andy Shevchenko

kmemdup_nul() strictly speaking is not related to the string API,
while being quite useful for it. Rephrase documentation to make it
clear that input data can be anything (any data, which may contain
any bytes, including 0x00).

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 mm/util.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/mm/util.c b/mm/util.c
index 9043d03750a7..3b717d34753b 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -133,13 +133,16 @@ void *kmemdup(const void *src, size_t len, gfp_t gfp)
 EXPORT_SYMBOL(kmemdup);
 
 /**
- * kmemdup_nul - Create a NUL-terminated string from unterminated data
+ * kmemdup_nul - Create a NUL-terminated data from unterminated one
  * @s: The data to stringify
  * @len: The size of the data
  * @gfp: the GFP mask used in the kmalloc() call when allocating memory
  *
+ * In particular this function is useful to add NUL-termination to
+ * unterminated strings.
+ *
  * Return: newly allocated copy of @s with NUL-termination or %NULL in
- * case of error
+ * case of error.
  */
 char *kmemdup_nul(const char *s, size_t len, gfp_t gfp)
 {
-- 
2.30.2


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input
  2021-07-19 12:20 [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input Andy Shevchenko
@ 2021-07-19 12:44 ` Matthew Wilcox
  2021-07-19 12:57   ` Andy Shevchenko
  0 siblings, 1 reply; 3+ messages in thread
From: Matthew Wilcox @ 2021-07-19 12:44 UTC (permalink / raw)
  To: Andy Shevchenko; +Cc: linux-mm, linux-kernel, Andrew Morton

On Mon, Jul 19, 2021 at 03:20:02PM +0300, Andy Shevchenko wrote:
> kmemdup_nul() strictly speaking is not related to the string API,
> while being quite useful for it. Rephrase documentation to make it
> clear that input data can be anything (any data, which may contain
> any bytes, including 0x00).

That's not a useful thing to do, though.  This rephrasing you've
done is more confusing than the original.


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input
  2021-07-19 12:44 ` Matthew Wilcox
@ 2021-07-19 12:57   ` Andy Shevchenko
  0 siblings, 0 replies; 3+ messages in thread
From: Andy Shevchenko @ 2021-07-19 12:57 UTC (permalink / raw)
  To: Matthew Wilcox; +Cc: linux-mm, linux-kernel, Andrew Morton

On Mon, Jul 19, 2021 at 01:44:22PM +0100, Matthew Wilcox wrote:
> On Mon, Jul 19, 2021 at 03:20:02PM +0300, Andy Shevchenko wrote:
> > kmemdup_nul() strictly speaking is not related to the string API,
> > while being quite useful for it. Rephrase documentation to make it
> > clear that input data can be anything (any data, which may contain
> > any bytes, including 0x00).
> 
> That's not a useful thing to do, though.  This rephrasing you've
> done is more confusing than the original.

Okay, then drop it. Sorry for the noise.

-- 
With Best Regards,
Andy Shevchenko



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-07-19 12:57 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-19 12:20 [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input Andy Shevchenko
2021-07-19 12:44 ` Matthew Wilcox
2021-07-19 12:57   ` Andy Shevchenko

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).