| 1 |
commit: b5dcf208b1798e0ba90adf5b85866b5e5ef42c65 |
| 2 |
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Tue Dec 31 17:41:52 2013 +0000 |
| 4 |
Commit: Brian Dolbec <brian.dolbec <AT> gmail <DOT> com> |
| 5 |
CommitDate: Fri Jan 3 18:02:21 2014 +0000 |
| 6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/catalyst.git;a=commit;h=b5dcf208 |
| 7 |
|
| 8 |
Add some docstring updates. |
| 9 |
|
| 10 |
--- |
| 11 |
catalyst/base/resume.py | 1 + |
| 12 |
catalyst/fileops.py | 6 ++++++ |
| 13 |
2 files changed, 7 insertions(+) |
| 14 |
|
| 15 |
diff --git a/catalyst/base/resume.py b/catalyst/base/resume.py |
| 16 |
index cf495fc..2c006ab 100644 |
| 17 |
--- a/catalyst/base/resume.py |
| 18 |
+++ b/catalyst/base/resume.py |
| 19 |
@@ -142,6 +142,7 @@ class AutoResume(object): |
| 20 |
def clear_all(self, remove=False): |
| 21 |
'''Clear all active resume points |
| 22 |
|
| 23 |
+ @remove: boolean, passed through to clear_dir() |
| 24 |
@return boolean |
| 25 |
''' |
| 26 |
if clear_dir(self.basedir, mode=0755, chg_flags=True, remove=remove): |
| 27 |
|
| 28 |
diff --git a/catalyst/fileops.py b/catalyst/fileops.py |
| 29 |
index 245c83e..fd98db2 100644 |
| 30 |
--- a/catalyst/fileops.py |
| 31 |
+++ b/catalyst/fileops.py |
| 32 |
@@ -52,6 +52,12 @@ def ensure_dirs(path, gid=-1, uid=-1, mode=0777, minimal=True, |
| 33 |
|
| 34 |
def clear_dir(target, mode=0755, chg_flags=False, remove=False): |
| 35 |
'''Universal directory clearing function |
| 36 |
+ |
| 37 |
+ @target: string, path to be cleared or removed |
| 38 |
+ @mode: integer, desired mode to set the directory to |
| 39 |
+ @chg_flags: boolean used for FreeBSD hoosts |
| 40 |
+ @remove: boolean, passed through to clear_dir() |
| 41 |
+ @return boolean |
| 42 |
''' |
| 43 |
#print "fileops.clear_dir()" |
| 44 |
if not target: |
Archives