From patchwork Mon Jul 19 12:20:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andy Shevchenko X-Patchwork-Id: 12385735 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A618FC07E9B for ; Mon, 19 Jul 2021 12:19:44 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 44EAC61026 for ; Mon, 19 Jul 2021 12:19:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 44EAC61026 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id E35A08D00F5; Mon, 19 Jul 2021 08:19:44 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id E0D8A8D00EC; Mon, 19 Jul 2021 08:19:44 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id CFCEE8D00F5; Mon, 19 Jul 2021 08:19:44 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0041.hostedemail.com [216.40.44.41]) by kanga.kvack.org (Postfix) with ESMTP id A97948D00EC for ; Mon, 19 Jul 2021 08:19:44 -0400 (EDT) Received: from smtpin32.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with ESMTP id 4EC7322BF9 for ; Mon, 19 Jul 2021 12:19:43 +0000 (UTC) X-FDA: 78379243446.32.1DC40FE Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by imf03.hostedemail.com (Postfix) with ESMTP id 239B8300018A for ; Mon, 19 Jul 2021 12:19:41 +0000 (UTC) X-IronPort-AV: E=McAfee;i="6200,9189,10049"; a="211041758" X-IronPort-AV: E=Sophos;i="5.84,252,1620716400"; d="scan'208";a="211041758" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Jul 2021 05:19:40 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,252,1620716400"; d="scan'208";a="499897119" Received: from black.fi.intel.com ([10.237.72.28]) by FMSMGA003.fm.intel.com with ESMTP; 19 Jul 2021 05:19:39 -0700 Received: by black.fi.intel.com (Postfix, from userid 1003) id D5F6A23A; Mon, 19 Jul 2021 15:20:05 +0300 (EEST) From: Andy Shevchenko To: linux-mm@kvack.org, linux-kernel@vger.kernel.org Cc: Andrew Morton , Andy Shevchenko Subject: [PATCH v1 1/1] mm/util: Rephrase documentation for kmemdup_nul() to clarify input Date: Mon, 19 Jul 2021 15:20:02 +0300 Message-Id: <20210719122002.41334-1-andriy.shevchenko@linux.intel.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Authentication-Results: imf03.hostedemail.com; dkim=none; dmarc=fail reason="No valid SPF, No valid DKIM" header.from=intel.com (policy=none); spf=none (imf03.hostedemail.com: domain of andriy.shevchenko@linux.intel.com has no SPF policy when checking 134.134.136.24) smtp.mailfrom=andriy.shevchenko@linux.intel.com X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 239B8300018A X-Stat-Signature: hf6s4zi3nqwccqg7j9mhxcgj6emid3ig X-HE-Tag: 1626697181-96169 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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 --- 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) {