summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Grover <agrover@redhat.com>2014-12-03 11:01:41 -0800
committerAndy Grover <agrover@redhat.com>2014-12-03 11:01:41 -0800
commit01651fd1dce2b0084d944df51dcf51c6a9fa5e71 (patch)
tree41c87420ca35debfe2b2f1f2906e429c97c81237
parente21ae87ba8de5bb9e2e6dc2f5457c1f40ce7db2a (diff)
downloadrtslib-fb-01651fd1dce2b0084d944df51dcf51c6a9fa5e71.tar.gz
Mention default save/restore file in docstrings
Mention default file used in save_to_file and restore_from_file docstrings. I tried to use the value of default_save_file instead of the explicit filename but string interpolation didn't seem to work for the docstring. Signed-off-by: Andy Grover <agrover@redhat.com>
-rw-r--r--rtslib/root.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/rtslib/root.py b/rtslib/root.py
index 301c2b9..6c2771f 100644
--- a/rtslib/root.py
+++ b/rtslib/root.py
@@ -229,6 +229,7 @@ class RTSRoot(CFSNode):
def save_to_file(self, save_file=None):
'''
Write the configuration in json format to a file.
+ Save file defaults to '/etc/targets/saveconfig.json'.
'''
if not save_file:
save_file = default_save_file
@@ -244,6 +245,7 @@ class RTSRoot(CFSNode):
def restore_from_file(self, restore_file=None, clear_existing=True, abort_on_error=False):
'''
Restore the configuration from a file in json format.
+ Restore file defaults to '/etc/targets/saveconfig.json'.
Returns a list of non-fatal errors. If abort_on_error is set,
it will raise the exception instead of continuing.
'''