diff options
| author |  Stefan Richter
| 2012-07-31 20:12:14 +0200 |
|---|---|---|
| committer | Stefan Richter
| 2012-07-31 20:31:35 +0200 |
| commit | 77dd78e3b478cc98498dd4b552a18969293c2941 (patch) | |
| tree | cc0c5079b3d2c0b1e9b90a8048a0ebdc1d7a3a57 | |
| parent | Changelog, NEWS: update to version 2.1.0 (diff) | |
Documentation improvement: return code of raw1394_read_cycle_timer{,_and_clock}
"the error code of the ioctl" is always -1. And ioctl() sets errno for us.
So let's say this in a way which is less likely to be misunderstood.
Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
| -rw-r--r-- | src/raw1394.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/raw1394.h b/src/raw1394.h index 8787313..7339311 100644 --- a/src/raw1394.h +++ b/src/raw1394.h @@ -369,7 +369,7 @@ int raw1394_read_cycle_timer(raw1394handle_t handle, * CLOCK_REALTIME is subject to resets; CLOCK_MONOTONIC is subject to gradual * adjustments; CLOCK_MONOTONIC_RAW is the bare hardware clock. * - * Returns: the error code of the ioctl, or 0 if successful. + * Returns: 0 on success or -1 on failure (sets errno) * * History: New function in libraw1394 v2.1.0. **/ |