diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 12:39:19 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:03:54 +0000 |
commit | a767879d88a91fe6274033ac210dd32680fa863e (patch) | |
tree | 975c14f1536a2dbad68b44c56d4eea96d4cbb5ff /morphlib/plugins/branch_and_merge_plugin.py | |
parent | 5ce4bde377308dcc7a2e7b15176ee2911c0d9184 (diff) | |
download | morph-a767879d88a91fe6274033ac210dd32680fa863e.tar.gz |
Improve docstring for "morph branch"
Diffstat (limited to 'morphlib/plugins/branch_and_merge_plugin.py')
-rw-r--r-- | morphlib/plugins/branch_and_merge_plugin.py | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/morphlib/plugins/branch_and_merge_plugin.py b/morphlib/plugins/branch_and_merge_plugin.py index 230367fb..0e1dcab6 100644 --- a/morphlib/plugins/branch_and_merge_plugin.py +++ b/morphlib/plugins/branch_and_merge_plugin.py @@ -610,7 +610,26 @@ class BranchAndMergePlugin(cliapp.Plugin): @warns_git_identity def branch(self, args): - '''Create a new system branch.''' + '''Create a new system branch. + + Command line arguments: + + * `REPO` is a repository URL. + * `NEW` is the name of the new system branch. + * `OLD` is the point from which to branch, and defaults to `master`. + + This creates a new system branch. It needs to be run in an + existing workspace (see `morph workspace`). It creates a new + git branch in the clone of the repository in the workspace. The + system branch will not be visible on the git server until you + push your changes to the repository. + + Example: + + cd /src/workspace + morph branch baserock:baserock:morphs jrandom/new-feature + + ''' if len(args) not in [2, 3]: raise cliapp.AppException('morph branch needs name of branch ' |