libcephfs: move ceph_mount_perms near the other UserPerm functions

...in the header. Also, add a doc comment.

Signed-off-by: Jeff Layton <jlayton@redhat.com>

diff --git a/src/include/cephfs/libcephfs.h b/src/include/cephfs/libcephfs.h
index cacdab98d451a76280d94ed2f63de2cc15ee9500..f616dfb050e287bc122a7b22ac6dec8d9ffd4698 100644 (file)
--- a/src/include/cephfs/libcephfs.h
+++ b/src/include/cephfs/libcephfs.h
@@ -152,6 +152,18 @@ UserPerm *ceph_userperm_new(uid_t uid, gid_t gid, int ngids, gid_t *gidlist);
  */
 void ceph_userperm_destroy(UserPerm *perm);
 
+/**
+ * Get a pointer to the default UserPerm object for the mount.
+ *
+ * @param cmount the mount info handle
+ *
+ * Every cmount has a default set of credentials. This returns a pointer to
+ * that object.
+ *
+ * Unlike with ceph_userperm_new, this object should not be freed.
+ */
+struct UserPerm *ceph_mount_perms(struct ceph_mount_info *cmount);
+
 /**
  * @defgroup libcephfs_h_init Setup and Teardown
  * These are the first and last functions that should be called
@@ -230,9 +242,6 @@ int ceph_init(struct ceph_mount_info *cmount);
  */
 int ceph_mount(struct ceph_mount_info *cmount, const char *root);
 
-
-struct UserPerm *ceph_mount_perms(struct ceph_mount_info *cmount);
-
 /**
  * Execute a management command remotely on an MDS.
  *