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 <[email protected]>
---
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
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.
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