Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit cc9e5616 authored by Takashi Sakamoto's avatar Takashi Sakamoto Committed by Greg Kroah-Hartman
Browse files

firewire: core: correct documentation of fw_csr_string() kernel API 

commit 5f9ab17394f831cb7986ec50900fa37507a127f1 upstream.

Against its current description, the kernel API can accepts all types of
directory entries.

This commit corrects the documentation.

Cc: stable@vger.kernel.org
Fixes: 3c2c58cb ("firewire: core: fw_csr_string addendum")
Link: https://lore.kernel.org/r/20240130100409.30128-2-o-takashi@sakamocchi.jp


Signed-off-by: default avatarTakashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 94a60022

drivers/firewire/core-device.c

+3 −4
Original line number Original line Diff line number Diff line
@@ -113,10 +113,9 @@ static int textual_leaf_to_string(const u32 *block, char *buf, size_t size) 
 * @buf:	where to put the string

 * @buf:	where to put the string

 * @size:	size of @buf, in bytes

 * @size:	size of @buf, in bytes

 *

 *

 * The string is taken from a minimal ASCII text descriptor leaf after

 * The string is taken from a minimal ASCII text descriptor leaf just after the entry with the

 * the immediate entry with @key.  The string is zero-terminated.

 * @key. The string is zero-terminated. An overlong string is silently truncated such that it

 * An overlong string is silently truncated such that it and the

 * and the zero byte fit into @size.

 * zero byte fit into @size.

 *

 *

 * Returns strlen(buf) or a negative error code.

 * Returns strlen(buf) or a negative error code.

 */

 */