libcephfs: clarify interface return value

Document that ceph_get_stripe_unit_granularity may return an error code
(e.g. -ENOTCONN). The interface requires a mount, but currently we
return a compile-time constant. Other error codes may be possible in the
future.

Signed-off-by: Noah Watkins <noahwatkins@gmail.com>

diff --git a/src/include/cephfs/libcephfs.h b/src/include/cephfs/libcephfs.h
index fa58694f108288b414e47f9e939f18177144a7a4..21eee2b5aeaa6d76ac2310c742bc17fd76ed820b 100644 (file)
--- a/src/include/cephfs/libcephfs.h
+++ b/src/include/cephfs/libcephfs.h
@@ -881,7 +881,7 @@ int ceph_get_file_stripe_address(struct ceph_mount_info *cmount, int fd, loff_t
 /**
  * Get the file layout stripe unit granularity.
  * @param cmount the ceph mount handle.
- * @returns the stripe unit granularity.
+ * @returns the stripe unit granularity or a negative error code on failure.
  */
 int ceph_get_stripe_unit_granularity(struct ceph_mount_info *cmount);