RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cephfs: improve doc comments for mount, unmount, release funcs 

Try to improve the doc comments for clarity and less redundancy.
Add "implements" subsections for the three functions.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2020-02-13 14:54:59 -05:00 committed by Niels de Vos
parent 0c1b895566
commit 522142665b
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
cephfs/cephfs.go
View File

@ -82,19 +82,28 @@ func (mount *MountInfo) ReadDefaultConfigFile() error {
return getError(ret) return getError(ret)
} }
// Mount mounts the mount handle. // Mount the file system, establishing a connection capable of I/O.
//
// Implements:
// int ceph_mount(struct ceph_mount_info *cmount, const char *root);
func (mount *MountInfo) Mount() error { func (mount *MountInfo) Mount() error {
ret := C.ceph_mount(mount.mount, nil) ret := C.ceph_mount(mount.mount, nil)
return getError(ret) return getError(ret)
} }
// Unmount unmounts the mount handle. // Unmount the file system.
//
// Implements:
// int ceph_unmount(struct ceph_mount_info *cmount);
func (mount *MountInfo) Unmount() error { func (mount *MountInfo) Unmount() error {
ret := C.ceph_unmount(mount.mount) ret := C.ceph_unmount(mount.mount)
return getError(ret) return getError(ret)
} }
// Release destroys the mount handle. // Release destroys the mount handle.
//
// Implements:
// int ceph_release(struct ceph_mount_info *cmount);
func (mount *MountInfo) Release() error { func (mount *MountInfo) Release() error {
ret := C.ceph_release(mount.mount) ret := C.ceph_release(mount.mount)
return getError(ret) return getError(ret)