From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E51A22EB15; Fri, 24 Nov 2023 19:20:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=linuxfoundation.org header.i=@linuxfoundation.org header.b="LXdBM+F3" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 72FA7C433C8; Fri, 24 Nov 2023 19:20:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1700853615; bh=/SWpbBLXjF3MT4uUx16LEWjiNcaw2sQzknNXZIulvTI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=LXdBM+F3ex1yV3kx6rXc5pniJISkQpt37H18H4HSl1upEoQa1xDAp+y8FSCh7JOEL PKL6f7ZARGhTzgl9x1mh8fc6dD5a1uEGZVUOkJLmLeRwoT6HEyeJDNc9t1GKC/MoDe cuoq5Bh4Sf0E5bUyakmtk5kAJfyuIiMG4ZEBMOFU= From: Greg Kroah-Hartman To: stable@vger.kernel.org Cc: Greg Kroah-Hartman , patches@lists.linux.dev, Alexander Duyck , Justin Stitt , Andrew Lunn , Paolo Abeni Subject: [PATCH 5.15 259/297] net: ethtool: Fix documentation of ethtool_sprintf() Date: Fri, 24 Nov 2023 17:55:01 +0000 Message-ID: <20231124172009.228083788@linuxfoundation.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231124172000.087816911@linuxfoundation.org> References: <20231124172000.087816911@linuxfoundation.org> User-Agent: quilt/0.67 X-stable: review X-Patchwork-Hint: ignore Precedence: bulk X-Mailing-List: stable@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 5.15-stable review patch. If anyone has any objections, please let me know. ------------------ From: Andrew Lunn commit f55d8e60f10909dbc5524e261041e1d28d7d20d8 upstream. This function takes a pointer to a pointer, unlike sprintf() which is passed a plain pointer. Fix up the documentation to make this clear. Fixes: 7888fe53b706 ("ethtool: Add common function for filling out strings") Cc: Alexander Duyck Cc: Justin Stitt Cc: stable@vger.kernel.org Signed-off-by: Andrew Lunn Reviewed-by: Justin Stitt Link: https://lore.kernel.org/r/20231028192511.100001-1-andrew@lunn.ch Signed-off-by: Paolo Abeni Signed-off-by: Greg Kroah-Hartman --- include/linux/ethtool.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) --- a/include/linux/ethtool.h +++ b/include/linux/ethtool.h @@ -781,10 +781,10 @@ int ethtool_get_phc_vclocks(struct net_d /** * ethtool_sprintf - Write formatted string to ethtool string data - * @data: Pointer to start of string to update + * @data: Pointer to a pointer to the start of string to update * @fmt: Format of string to write * - * Write formatted string to data. Update data to point at start of + * Write formatted string to *data. Update *data to point at start of * next string. */ extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);