On Sat, Oct 28, 2023 at 12:25 PM Andrew Lunn <andrew@xxxxxxx> wrote:
>
> 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>
> ---
> include/linux/ethtool.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h
> index 62b61527bcc4..1b523fd48586 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, ...);
> --
> 2.42.0
>
Great! Now the docs more appropriately describe the behavior. My patch [1]
for ethtool_puts() will use this same wording you've introduced.
Reviewed-by: Justin Stitt <justinstitt@xxxxxxxxxx>
[1]: https://lore.kernel.org/all/20231027-ethtool_puts_impl-v3-0-3466ac679304@xxxxxxxxxx/
Thanks
Justin
