]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
libcephfs: fix documentation for ceph_readlink
authorCasey Bodley <casey@linuxbox.com>
Mon, 10 Feb 2014 16:33:09 +0000 (11:33 -0500)
committerCasey Bodley <casey@linuxbox.com>
Mon, 10 Feb 2014 16:35:20 +0000 (11:35 -0500)
ceph_readlink() and ceph_ll_readlink() both return the number of bytes
copied on success, which the callers need to guarantee null-termination

Signed-off-by: Casey Bodley <casey@linuxbox.com>
src/include/cephfs/libcephfs.h

index eb265faf771746c0c1604113bae9617c32b61975..e600605b36c4159662e3d95e980fe2f77f85df66 100644 (file)
@@ -497,7 +497,7 @@ int ceph_link(struct ceph_mount_info *cmount, const char *existing, const char *
  * @param path the path to the symlink to read
  * @param buf the buffer to hold the the path of the file that the symlink points to.
  * @param size the length of the buffer
- * @returns 0 on success or negative error code on failure
+ * @returns number of bytes copied on success or negative error code on failure
  */
 int ceph_readlink(struct ceph_mount_info *cmount, const char *path, char *buf, int64_t size);