diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 15:50:37 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:35:46 +0000 |
commit | e8942a20e72ca725394d654b6cb80d7ceb343651 (patch) | |
tree | e2858266b2f2d9c608e3416916d272890c362e9b /morphlib/plugins/show_dependencies_plugin.py | |
parent | 715d1edd29e8c4920d181080a709557fb4223c18 (diff) | |
download | morph-e8942a20e72ca725394d654b6cb80d7ceb343651.tar.gz |
Improve docstring for "morph show-dependencies"
Diffstat (limited to 'morphlib/plugins/show_dependencies_plugin.py')
-rw-r--r-- | morphlib/plugins/show_dependencies_plugin.py | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/morphlib/plugins/show_dependencies_plugin.py b/morphlib/plugins/show_dependencies_plugin.py index e4e40311..856a9361 100644 --- a/morphlib/plugins/show_dependencies_plugin.py +++ b/morphlib/plugins/show_dependencies_plugin.py @@ -31,7 +31,18 @@ class ShowDependenciesPlugin(cliapp.Plugin): pass def show_dependencies(self, args): - '''Dumps the dependency tree of all input morphologies''' + '''Dumps the dependency tree of all input morphologies. + + Command line arguments: + + * `REPO` is a git repository URL. + * `REF` is a branch or other commit reference in that repository. + * `FILENAME` is a morphology filename at that ref. + + This command analyses a system morphology and produces a listing + of build dependencies of the constituent components. + + ''' if not os.path.exists(self.app.settings['cachedir']): os.mkdir(self.app.settings['cachedir']) |