[PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input

* [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 related	[flat|nested] 3+ messages in thread