diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 16:30:49 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:35:46 +0000 |
commit | 14cd355f44f1c0d1878bab292cf87767d4a2dd6e (patch) | |
tree | de12b8a3a112aa6f1c9ce0607ad6c6c6d478837c /morphlib/plugins/branch_and_merge_plugin.py | |
parent | dc614317a60e41d2b22796a49a61e65a822e547d (diff) | |
download | morph-14cd355f44f1c0d1878bab292cf87767d4a2dd6e.tar.gz |
Improve docstring for "morph tag"
Diffstat (limited to 'morphlib/plugins/branch_and_merge_plugin.py')
-rw-r--r-- | morphlib/plugins/branch_and_merge_plugin.py | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/morphlib/plugins/branch_and_merge_plugin.py b/morphlib/plugins/branch_and_merge_plugin.py index 2039a603..f25e73e6 100644 --- a/morphlib/plugins/branch_and_merge_plugin.py +++ b/morphlib/plugins/branch_and_merge_plugin.py @@ -68,7 +68,8 @@ class BranchAndMergePlugin(cliapp.Plugin): arg_synopsis='SYSTEM STRATUM [CHUNK]') self.app.add_subcommand('petrify', self.petrify) self.app.add_subcommand('unpetrify', self.unpetrify) - self.app.add_subcommand('tag', self.tag) + self.app.add_subcommand( + 'tag', self.tag, arg_synopsis='TAG-NAME -- [GIT-COMMIT-ARG...]') self.app.add_subcommand('build', self.build, arg_synopsis='SYSTEM') self.app.add_subcommand('status', self.status) @@ -1129,6 +1130,26 @@ class BranchAndMergePlugin(cliapp.Plugin): @warns_git_identity def tag(self, args): + '''Create an annotated Git tag of a petrified system branch. + + Command line arguments: + + * `TAG-NAME` is the name of the Git tag to be created. + * `--` separates the Git arguments and options from the ones + Morph parses for itself. + * `GIT-COMMIT-ARG` is a `git commit` option or argument, + e.g., '-m' or '-F'. These should provide the commit message. + + This command creates an annotated Git tag that points at a commit + where all system and stratum morphologies have been petrified. + The working tree won't be petrified, only the commit. + + Example: + + morph tag release-12.765 -- -m "Release 12.765" + + ''' + if len(args) < 1: raise cliapp.AppException('morph tag expects a tag name') |