This is a note to let you know that I've just added the patch titled
net: ethtool: Fix documentation of ethtool_sprintf()
to the 5.15-stable tree which can be found at:
http://www.kernel.org/git/?p=linux/kernel/git/stable/stable-queue.git;a=summary
The filename of the patch is:
net-ethtool-fix-documentation-of-ethtool_sprintf.patch
and it can be found in the queue-5.15 subdirectory.
If you, or anyone else, feels it should not be added to the stable tree,
please let <stable@xxxxxxxxxxxxxxx> know about it.
>From f55d8e60f10909dbc5524e261041e1d28d7d20d8 Mon Sep 17 00:00:00 2001
From: Andrew Lunn <andrew@xxxxxxx>
Date: Sat, 28 Oct 2023 21:25:11 +0200
Subject: net: ethtool: Fix documentation of ethtool_sprintf()
From: Andrew Lunn <andrew@xxxxxxx>
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 <alexanderduyck@xxxxxx>
Cc: Justin Stitt <justinstitt@xxxxxxxxxx>
Cc: stable@xxxxxxxxxxxxxxx
Signed-off-by: Andrew Lunn <andrew@xxxxxxx>
Reviewed-by: Justin Stitt <justinstitt@xxxxxxxxxx>
Link: https://lore.kernel.org/r/20231028192511.100001-1-andrew@xxxxxxx
Signed-off-by: Paolo Abeni <pabeni@xxxxxxxxxx>
Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
---
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, ...);
Patches currently in stable-queue which might be from andrew@xxxxxxx are
queue-5.15/net-dsa-lan9303-consequently-nested-lock-physical-mdio.patch
queue-5.15/net-ethtool-fix-documentation-of-ethtool_sprintf.patch
queue-5.15/net-phylink-initialize-carrier-state-at-creation.patch
queue-5.15/net-ethernet-cortina-fix-mtu-max-setting.patch
queue-5.15/net-ethernet-cortina-fix-max-rx-frame-define.patch
