summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDanny Al-Gaaf <danny.al-gaaf@bisect.de>2013-04-05 15:58:25 +0200
committerDanny Al-Gaaf <danny.al-gaaf@bisect.de>2013-04-07 18:31:21 +0200
commit2124a4b10405c0ea79904948ecbb884ed8a22e3d (patch)
tree51571b38705dfe3660ce5af8daacd424e432d4f9
parent94a1f25e7230a700f06a2699c9c2b99ec1bf7144 (diff)
downloadceph-2124a4b10405c0ea79904948ecbb884ed8a22e3d.tar.gz
cephfs.py: add docstring for shutdown() and version()
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
-rw-r--r--src/pybind/cephfs.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/pybind/cephfs.py b/src/pybind/cephfs.py
index 6a769b2a8aa..f89f53fb194 100644
--- a/src/pybind/cephfs.py
+++ b/src/pybind/cephfs.py
@@ -152,6 +152,9 @@ class LibCephFS(object):
raise make_ex(ret, "error calling conf_read_file")
def shutdown(self):
+ """
+ Unmount and destroy the ceph mount handle.
+ """
if self.state != "shutdown":
self.libcephfs.ceph_shutdown(self.cluster)
self.state = "shutdown"
@@ -168,6 +171,12 @@ class LibCephFS(object):
self.shutdown()
def version(self):
+ """
+ Get the version number of the ``libcephfs`` C library.
+
+ :returns: a tuple of ``(major, minor, extra)`` components of the
+ libcephfs version
+ """
major = c_int(0)
minor = c_int(0)
extra = c_int(0)