renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-11-27 20:13:57 +08:00
Code

firewire: core: document fw_csr_string's truncation of long strings

Browse Source 
fw_csr_string() truncates and terminates target strings like strlcpy()
does.  Unlike strlcpy(), it returns the target strlen, not the source
strlen, hence users of fw_csr_string() are unable to detect truncation.

Point this behavior out in the kerneldoc comment.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Reviewed-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
This commit is contained in:
Stefan Richter 2014-11-19 11:52:00 +01:00
parent 51b04d59c2
commit 0238507b95
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
drivers/firewire/core-device.c
View File

@ -115,6 +115,9 @@ static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
* *
* The string is taken from a minimal ASCII text descriptor leaf after * The string is taken from a minimal ASCII text descriptor leaf after
* the immediate entry with @key. The string is zero-terminated. * 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.
*
* Returns strlen(buf) or a negative error code. * Returns strlen(buf) or a negative error code.
*/ */
int fw_csr_string(const u32 *directory, int key, char *buf, size_t size) int fw_csr_string(const u32 *directory, int key, char *buf, size_t size)