Skip to content

Commit 5f9ab17

Browse files
committed
firewire: core: correct documentation of fw_csr_string() kernel API
Against its current description, the kernel API can accepts all types of directory entries. This commit corrects the documentation. Cc: [email protected] Fixes: 3c2c58c ("firewire: core: fw_csr_string addendum") Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Takashi Sakamoto <[email protected]>
1 parent 41bccc9 commit 5f9ab17

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

drivers/firewire/core-device.c

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,9 @@ static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
118118
* @buf: where to put the string
119119
* @size: size of @buf, in bytes
120120
*
121-
* The string is taken from a minimal ASCII text descriptor leaf after
122-
* the immediate entry with @key. The string is zero-terminated.
123-
* An overlong string is silently truncated such that it and the
124-
* zero byte fit into @size.
121+
* The string is taken from a minimal ASCII text descriptor leaf just after the entry with the
122+
* @key. The string is zero-terminated. An overlong string is silently truncated such that it
123+
* and the zero byte fit into @size.
125124
*
126125
* Returns strlen(buf) or a negative error code.
127126
*/

0 commit comments

Comments
 (0)