summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-04 12:52:37 +0000
committerLars Wirzenius <lars.wirzenius@codethink.co.uk>2013-07-05 14:09:28 +0000
commit3fa06f716a4f7a9519ff6a46f92d4b01b9a27f8a (patch)
tree47decbc13c1e13f298429ebb8bb6d4e920a5561a
parent40b8a6785a9dba8d865b034d3d265ded7c90b5e6 (diff)
downloaddefinitions-3fa06f716a4f7a9519ff6a46f92d4b01b9a27f8a.tar.gz
Improve docstring for "morph build-morphology"
-rw-r--r--morphlib/plugins/build_plugin.py23
1 files changed, 20 insertions, 3 deletions
diff --git a/morphlib/plugins/build_plugin.py b/morphlib/plugins/build_plugin.py
index 128187cf..e9555888 100644
--- a/morphlib/plugins/build_plugin.py
+++ b/morphlib/plugins/build_plugin.py
@@ -29,10 +29,27 @@ class BuildPlugin(cliapp.Plugin):
pass
def build_morphology(self, args):
- '''Build a system, outside of a system branch
+ '''Build a system, outside of a system branch.
- Command line arguments are the repository, git ref,
- and morphology filename.
+ 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.
+
+ You probably want `morph build` instead. However, in some
+ cases it is more convenient to not have to create a Morph
+ workspace and check out the relevant system branch, and only
+ just run the build. For those times, this command exists.
+
+ This subcommand does not automatically commit changes to a
+ temporary branch, so you can only build from properly committed
+ sources that have been pushed to the git server.
+
+ Example:
+
+ morph build-morphology baserock:baserock/morphs \
+ master devel-system-x86_64-generic
'''