RemoteFS: Fix doc for locked_volume_id_operation

Doctext should mention that this works on methods taking 'volume'
or 'snapshot' arguments.

Also reworded the method description to clarify a bit.

Change-Id: Ib97746157dd6fd53c37fd4bde3d3de12a1727ec2

diff --git a/cinder/volume/drivers/remotefs.py b/cinder/volume/drivers/remotefs.py
index 109e9ca9b3a2b3be1dd96d2c30408e60e7695137..554d39341e1b7bec6a271b79dc0769598f82fa9c 100644 (file)
--- a/cinder/volume/drivers/remotefs.py
+++ b/cinder/volume/drivers/remotefs.py
@@ -92,11 +92,10 @@ def locked_volume_id_operation(f, external=False):
     """Lock decorator for volume operations.
 
        Takes a named lock prior to executing the operation. The lock is named
-       with the id of the volume. This lock can then be used
-       by other operations to avoid operation conflicts on shared volumes.
+       with the id of the volume. This lock can be used by driver methods
+       to prevent conflicts with other operations modifying the same volume.
 
-       May be applied to methods of signature:
-          method(<self>, volume, *, **)
+       May be applied to methods that take a 'volume' or 'snapshot' argument.
     """
 
     def lvo_inner1(inst, *args, **kwargs):