firewire: core: document fw_csr_string's truncation of long strings
authorStefan Richter <stefanr@s5r6.in-berlin.de>
Wed, 19 Nov 2014 10:52:00 +0000 (11:52 +0100)
committerStefan Richter <stefanr@s5r6.in-berlin.de>
Wed, 10 Dec 2014 19:53:02 +0000 (20:53 +0100)
commit0238507b951857360461b0635111e7376ffd44d1
treec6952e34b302fc2f3fac4fbdcffa369bf264d611
parent51b04d59c27430a57c347b55478415c342009035
firewire: core: document fw_csr_string's truncation of long strings

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>
drivers/firewire/core-device.c
This page took 0.026871 seconds and 5 git commands to generate.