diff options
author | Andrew Lunn <andrew@lunn.ch> | 2023-10-28 21:25:11 +0200 |
---|---|---|
committer | Paolo Abeni <pabeni@redhat.com> | 2023-11-02 12:17:17 +0100 |
commit | f55d8e60f10909dbc5524e261041e1d28d7d20d8 (patch) | |
tree | 58485bfa76a66f5dfe4c083e8f02f2826b8e77b9 | |
parent | 5a22fbcc10f3f7d94c5d88afbbffa240a3677057 (diff) | |
download | lwn-f55d8e60f10909dbc5524e261041e1d28d7d20d8.tar.gz lwn-f55d8e60f10909dbc5524e261041e1d28d7d20d8.zip |
net: ethtool: Fix documentation of ethtool_sprintf()
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@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>
-rw-r--r-- | include/linux/ethtool.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h index 226a36ed5aa1..689028257fcc 100644 --- a/include/linux/ethtool.h +++ b/include/linux/ethtool.h @@ -1045,10 +1045,10 @@ static inline int ethtool_mm_frag_size_min_to_add(u32 val_min, u32 *val_add, /** * 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, ...); |