added documentaion in tmp_func
authorPaul Tonelli <paul.tonelli@logilab.fr>
Tue, 05 Mar 2013 16:06:30 +0100
changeset 23 b6572bd0293c
parent 22 6cd919e309f1
child 24 5a66ef9f5377
added documentaion in tmp_func
_states/tmp_func.py
--- a/_states/tmp_func.py	Tue Mar 05 15:56:42 2013 +0100
+++ b/_states/tmp_func.py	Tue Mar 05 16:06:30 2013 +0100
@@ -2,6 +2,14 @@
 import os.path
 
 def local_managed(name, source):
+    '''
+    Manage a file locally: if name is different from source (md5sum), then copy it
+
+    name
+        The location of the managed file
+    source
+        The location of the source file
+    '''
     ret = {'name': name,
             'changes': {},
             'result': True,
@@ -34,6 +42,13 @@
     return ret
 
 def umounted(name):
+    '''
+    Make sure nothing is mounted into name and, if possible, umounts it (fails if it contains others mounts)
+
+    name
+        The location of the mounting point
+    '''
+
     ret = {'name': name,
             'changes': {},
             'result': True,