summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-04 13:21:44 +0000
committerLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-05 14:35:46 +0000
commit8ec70370eb32fb8c0f63192aff5f76e857d67c8b (patch)
treec95700ac1b014cd38a842ad0c8fb1b09244023cc
parent931704c25eab3268db847179c69103b9752c75ba (diff)
downloaddefinitions-8ec70370eb32fb8c0f63192aff5f76e857d67c8b.tar.gz
Improve docstring for "morph update-gits"
-rw-r--r--morphlib/plugins/update_gits_plugin.py17
1 files changed, 16 insertions, 1 deletions
diff --git a/morphlib/plugins/update_gits_plugin.py b/morphlib/plugins/update_gits_plugin.py
index 083439f5..e3d7a81b 100644
--- a/morphlib/plugins/update_gits_plugin.py
+++ b/morphlib/plugins/update_gits_plugin.py
@@ -31,7 +31,22 @@ class UpdateGitsPlugin(cliapp.Plugin):
pass
def update_gits(self, args):
- '''Manually update cached git repositories for the given morphology'''
+ '''Manually update cached git repositories for the given morphology
+
+ Command line arguments:
+
+ * `REPO` is a git repository URL.
+ * `REF` is a git commit ref (sha1, branch, tag).
+ * `MORPHOLOGY` is a morphology filename.
+
+ This updates the local cached copy of a git repository, and any
+ git repositories of components in the morphology (for system
+ and stratum morphologies).
+
+ You do not normally need to do this. Morph updates the cached
+ repositories automatically anyway.
+
+ '''
app = self.app
if not os.path.exists(app.settings['cachedir']):