diff options
| author |  Stefan Richter
| 2010-01-31 11:33:08 +0100 |
|---|---|---|
| committer | Stefan Richter
| 2010-02-01 22:10:12 +0100 |
| commit | f806f3d0de39fa405b63b7dbea84fc79b97d3079 (patch) | |
| tree | d46c5bf3de459095063c5b0876b10aafd2845aed /libraw1394.spec.in | |
| parent | doc: let "make clean" remove generated HTML files (diff) | |
Fix documentation of return values of raw1394_start_ family of functions
If running on top of the raw1394 kernel driver (any kernel version) or
on top of firewire-core (kernel version <= 2.6.29), raw1394_start_*
functions will return a value > 0 on success, not == 0. Only with
firewire-core of kernel 2.6.30 or later, == 0 is returned on success.
The exact value depends on which driver is used, on CPU architecture,
and on request payload size in case of some types of requests. In any
case, only that the value is > or == 0 on success (but == -1 on
failure) is significant to libraw1394 client applications.
This mismatch between documentation and implementation was already
present in older libraw1394 versions, including v1.x. For the time
being, do not change the implementation, only adjust the documentation.
Reported-by: Dr. David Alan Gilbert
Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Diffstat (limited to 'libraw1394.spec.in')
0 files changed, 0 insertions, 0 deletions