Skip to content

Commit 656262c

Browse files
lunngregkh
authored andcommitted
net: ethtool: Fix documentation of ethtool_sprintf()
commit f55d8e6 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: 7888fe5 ("ethtool: Add common function for filling out strings") Cc: Alexander Duyck <alexanderduyck@fb.com> Cc: Justin Stitt <justinstitt@google.com> Cc: stable@vger.kernel.org Signed-off-by: Andrew Lunn <andrew@lunn.ch> Reviewed-by: Justin Stitt <justinstitt@google.com> Link: https://lore.kernel.org/r/20231028192511.100001-1-andrew@lunn.ch Signed-off-by: Paolo Abeni <pabeni@redhat.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent acca20c commit 656262c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/linux/ethtool.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -781,10 +781,10 @@ int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index);
781781

782782
/**
783783
* ethtool_sprintf - Write formatted string to ethtool string data
784-
* @data: Pointer to start of string to update
784+
* @data: Pointer to a pointer to the start of string to update
785785
* @fmt: Format of string to write
786786
*
787-
* Write formatted string to data. Update data to point at start of
787+
* Write formatted string to *data. Update *data to point at start of
788788
* next string.
789789
*/
790790
extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);

0 commit comments

Comments
 (0)