From: Stefan Richter <stefanr@s5r6.in-berlin.de>
Date: Wed, 19 Nov 2014 10:52:00 +0000 (+0100)
Subject: firewire: core: document fw_csr_string's truncation of long strings
X-Git-Tag: omap-for-v3.19/fixes-rc1~74^2~3
X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0238507b951857360461b0635111e7376ffd44d1;p=pandora-kernel.git

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>
---

Reading git-diff-tree failed