diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 12:54:10 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:09:29 +0000 |
commit | 1c1365db29168d50f9baa2e804cc893a7257bdd3 (patch) | |
tree | 7109a77e95492b3a08b49b97ae06651ca4e4cfb4 /morphlib | |
parent | 3fa06f716a4f7a9519ff6a46f92d4b01b9a27f8a (diff) | |
download | morph-1c1365db29168d50f9baa2e804cc893a7257bdd3.tar.gz |
Improve docstring for "morph checkout"
Diffstat (limited to 'morphlib')
-rw-r--r-- | morphlib/plugins/branch_and_merge_plugin.py | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/morphlib/plugins/branch_and_merge_plugin.py b/morphlib/plugins/branch_and_merge_plugin.py index e7ed4f1d..9ad8eed1 100644 --- a/morphlib/plugins/branch_and_merge_plugin.py +++ b/morphlib/plugins/branch_and_merge_plugin.py @@ -650,7 +650,25 @@ class BranchAndMergePlugin(cliapp.Plugin): @warns_git_identity def checkout(self, args): - '''Check out an existing system branch.''' + '''Check out an existing system branch. + + Command line arguments: + + * `REPO` is the URL to the repository to the root repository of + a system branch. + * `BRANCH` is the name of the system branch. + + This will check out an existing system branch to an existing + workspace. You must create the workspace first. This only checks + out the root repository, not the repositories for individual + components. You need to use `morph edit` to check out those. + + Example: + + cd /src/workspace + morph checkout baserock:baserock/morphs master + + ''' if len(args) != 2: raise cliapp.AppException('morph checkout needs a repo and the ' |