From 14cd355f44f1c0d1878bab292cf87767d4a2dd6e Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Thu, 4 Jul 2013 16:30:49 +0000 Subject: Improve docstring for "morph tag" --- morphlib/plugins/branch_and_merge_plugin.py | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'morphlib/plugins/branch_and_merge_plugin.py') 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') -- cgit v1.2.1