summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-04 16:02:11 +0000
committerLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-05 14:35:46 +0000
commitdc614317a60e41d2b22796a49a61e65a822e547d (patch)
treeb96eb047fd83352bea05340f5761b8ff6f7b0404
parente8942a20e72ca725394d654b6cb80d7ceb343651 (diff)
downloaddefinitions-dc614317a60e41d2b22796a49a61e65a822e547d.tar.gz
Improve docstring for "morph trovectl"
-rw-r--r--morphlib/plugins/trovectl_plugin.py23
1 files changed, 22 insertions, 1 deletions
diff --git a/morphlib/plugins/trovectl_plugin.py b/morphlib/plugins/trovectl_plugin.py
index fe96cc49..7db2cbb5 100644
--- a/morphlib/plugins/trovectl_plugin.py
+++ b/morphlib/plugins/trovectl_plugin.py
@@ -20,12 +20,33 @@ import morphlib
class TrovectlPlugin(cliapp.Plugin):
def enable(self):
- self.app.add_subcommand('trovectl', self.trovectl)
+ self.app.add_subcommand(
+ 'trovectl', self.trovectl, arg_synopsis='GITANO-COMMAND [ARG...]')
def disable(self):
pass
def trovectl(self, args, **kwargs):
+ '''Invoke Gitano commands on the Trove host.
+
+ Command line arguments:
+
+ * `GITANO-COMMAND` is the Gitano command to invoke on the Trove.
+ * `ARG` is a Gitano command argument.
+
+ This invokes Gitano commands on the Trove host configured
+ in the Morph configuration (see `--trove-host`).
+
+ Trove is the Codethink code hosting appliance. Gitano is the
+ git server management component of that.
+
+ Example:
+
+ morph trovectl whoami
+ morph trovectl help
+
+ '''
+
trove = 'git@' + self.app.settings['trove-host']
self.app.runcmd(['ssh', trove] + args,
stdout=None, stderr=None)