diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 16:02:11 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:35:46 +0000 |
commit | dc614317a60e41d2b22796a49a61e65a822e547d (patch) | |
tree | b96eb047fd83352bea05340f5761b8ff6f7b0404 /morphlib/plugins/trovectl_plugin.py | |
parent | e8942a20e72ca725394d654b6cb80d7ceb343651 (diff) | |
download | morph-dc614317a60e41d2b22796a49a61e65a822e547d.tar.gz |
Improve docstring for "morph trovectl"
Diffstat (limited to 'morphlib/plugins/trovectl_plugin.py')
-rw-r--r-- | morphlib/plugins/trovectl_plugin.py | 23 |
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) |