[sanlock] 01/03: python: improve get/set_lvb documentation

This is an automated email from the git hooks/post-receive script.

nsoffer pushed a commit to branch master
in repository sanlock.

commit cb06607f19920b9f68c0aa81e7533638b25f01b9
Author: Benny Zlotnik <bzlotnik(a)redhat.com&gt;
AuthorDate: Wed Dec 9 09:57:54 2020 +0200

    python: improve get/set_lvb documentation
    
    - Specify lvb=True explicitly instead of mentioning the sanlock flag
    - Document when data is written and visible
    - Unify whitespace in function documentation, consistent with other
      functions.
    
    Signed-off-by: Benny Zlotnik <bzlotnik(a)redhat.com&gt;
    Signed-off-by: Nir Soffer <nsoffer(a)redhat.com&gt;
---
 python/sanlock.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/python/sanlock.c b/python/sanlock.c
index fbcabb1..7c1a13f 100644
--- a/python/sanlock.c
+++ b/python/sanlock.c
@@ -1606,8 +1606,11 @@ Arguments\n\
   data              data to write (bytes)\n\
 \n\
 Notes\n\
-\n\
-The resource must be acquired with the SANLK_ACQUIRE_LVB flag\n");
+  The resource must be acquired with lvb=true.\n\
+  The size of data is limited by the sector size (512/4K).\n\
+  The new data is visible after the resource is released.\n\
+");
+
 static PyObject *
 py_set_lvb(PyObject *self __unused, PyObject *args, PyObject *keywds)
 {
@@ -1660,9 +1663,11 @@ Arguments\n\
 \n\
 Returns\n\
   data              data written with set_lvb\n\
-Notes\n\
 \n\
-The resource must be acquired with the SANLK_ACQUIRE_LVB flag\n");
+Notes\n\
+  The resource must be acquired with lvb=True.\n\
+");
+
 static PyObject *
 py_get_lvb(PyObject *self __unused, PyObject *args, PyObject *keywds)
 {

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.