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: 3c2c58cb33b3 ("firewire: core: fw_csr_string addendum") Link: https://lore.kernel.org/r/20240130100409.30128-2-o-takashi@sakamocchi.jp Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
parent
0e74b22926
commit
bdb5bf65da
1 changed files with 3 additions and 4 deletions
|
@ -100,10 +100,9 @@ static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
|
|||
* @buf: where to put the string
|
||||
* @size: size of @buf, in bytes
|
||||
*
|
||||
* The string is taken from a minimal ASCII text descriptor leaf after
|
||||
* the immediate entry with @key. The string is zero-terminated.
|
||||
* An overlong string is silently truncated such that it and the
|
||||
* zero byte fit into @size.
|
||||
* The string is taken from a minimal ASCII text descriptor leaf just after the entry with the
|
||||
* @key. The string is zero-terminated. An overlong string is silently truncated such that it
|
||||
* and the zero byte fit into @size.
|
||||
*
|
||||
* Returns strlen(buf) or a negative error code.
|
||||
*/
|
||||
|
|
Loading…
Add table
Reference in a new issue