Skip to content

Commit eef592e

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 <[email protected]> Cc: Justin Stitt <[email protected]> Cc: [email protected] Signed-off-by: Andrew Lunn <[email protected]> Reviewed-by: Justin Stitt <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Paolo Abeni <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent 57e35d9 commit eef592e

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
@@ -836,10 +836,10 @@ int ethtool_get_phc_vclocks(struct net_device *dev, int **vclock_index);
836836

837837
/**
838838
* ethtool_sprintf - Write formatted string to ethtool string data
839-
* @data: Pointer to start of string to update
839+
* @data: Pointer to a pointer to the start of string to update
840840
* @fmt: Format of string to write
841841
*
842-
* Write formatted string to data. Update data to point at start of
842+
* Write formatted string to *data. Update *data to point at start of
843843
* next string.
844844
*/
845845
extern __printf(2, 3) void ethtool_sprintf(u8 **data, const char *fmt, ...);

0 commit comments

Comments
 (0)