diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 12:44:20 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:06:21 +0000 |
commit | 40b8a6785a9dba8d865b034d3d265ded7c90b5e6 (patch) | |
tree | ea586f52340d7e4292017f9028f06d74e0965648 | |
parent | a767879d88a91fe6274033ac210dd32680fa863e (diff) | |
download | definitions-40b8a6785a9dba8d865b034d3d265ded7c90b5e6.tar.gz |
Improve docstring for "morph build"
-rw-r--r-- | morphlib/plugins/branch_and_merge_plugin.py | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/morphlib/plugins/branch_and_merge_plugin.py b/morphlib/plugins/branch_and_merge_plugin.py index 0e1dcab6..e7ed4f1d 100644 --- a/morphlib/plugins/branch_and_merge_plugin.py +++ b/morphlib/plugins/branch_and_merge_plugin.py @@ -1497,7 +1497,31 @@ class BranchAndMergePlugin(cliapp.Plugin): raise def build(self, args): - '''Build a system from the current system branch''' + '''Build a system image in the current system branch + + Command line arguments: + + * `SYSTEM` is the name of the system to build. + + This builds a system image, and any of its components that + need building. The system name is the basename of the system + morphology, in the root repository of the current system branch, + without the `.morph` suffix in the filename. + + The location of the resulting system image artifact is printed + at the end of the build output. + + You do not need to commit your changes before building, Morph + does that for you, in a temporary branch for each build. However, + note that Morph does not untracked files to the temporary branch, + only uncommitted changes to files git already knows about. You + need to `git add` and commit each new file yourself. + + Example: + + morph build devel-system-x86_64-generic + + ''' if len(args) != 1: raise cliapp.AppException('morph build expects exactly one ' |