Commits

Yujie Wu  committed 924b344

Updated documentation, and made `--user` and `--stamp` be options of the `upgrade` command.

  • Participants
  • Parent commits a954872
  • Branches hotfix/0.9.6/add_stamp_option

Comments (0)

Files changed (1)

File src/hgflow.py

 
 options:
  -r --rev REV       Revision to start a new branch from.
- -m --message TEXT  Record TEXT as commit message when open new branch.
+ -m --message TEXT  Record TEXT as commit message when opening new branch.
+ -p --stamp TEXT    Append TEXT to all commit messages.
  -d --date DATE     Record the specified DATE as commit date.
  -u --user USER     Use specified USER as committer.
     --dirty         Start a new branch from current dirty workspace branch and
 options:
  -c --commit        Commit changes before close the branch.
  -m --message TEXT  Record TEXT as commit message.
+ -p --stamp TEXT    Append TEXT to all commit messages.
  -d --date DATE     Record the specified DATE as commit date.
  -u --user USER     Use specified USER as committer.
  -e --erase         Erase branch after it is merged successfully.
 <support>), this syntax is completely equivalent to the other one.
 
 option:
--c --closed    Show open and closed branches in <stream>.
+ -c --closed    Show open and closed branches in <stream>.
 """,
 
 "@log" : """
 syntax:
 {{{hg flow <stream> abort [-m <TEXT>] [-e]}}}
 
-option:
- -m --message TEXT  Record TEXT as commit message when close branch.
+options:
+ -m --message TEXT  Record TEXT as commit message when closing branch.
+ -p --stamp TEXT    Append TEXT to all commit messages.
  -e --erase         Abort branch and erase it.
 """,
 
 The workspace branch must be in <stream>. If the `-r` option is omitted, its
 value will default to the head of the workspace branch.
 
-option:
+options:
  -r --rev REV       Revision to promote to other branches.
- -m --message TEXT  Record TEXT as commit message when promote branch.
+ -m --message TEXT  Record TEXT as commit message when promoting branch.
+ -p --stamp TEXT    Append TEXT to all commit messages.
  -t --tag NAME      Tag the merging changeset with NAME
  -d --date DATE     Record the specified DATE as commit date.
  -u --user USER     Use specified USER as committer.
 syntax:
 {{{hg flow <stream> rebase [-d <rev>]}}}
 
+option:
+ -p --stamp TEXT  Append TEXT to all commit messages.
+
 The workspace branch must be in <stream>. If the destination revision is not
 specified, it will default to the source branch of the workspace branch.
 """,
 {{{hg flow init [<option>...]}}}
 
 options:
- -f --force  Force reinitializing flow.
- -u --user USER     Use specified USER as committer.
+ -f --force       Force reinitializing flow.
+ -u --user USER   Use specified USER as committer.
+ -p --stamp TEXT  Append TEXT to all commit messages.
 """,
 
 "@upgrade" : """
 
 syntax:
 {{{hg flow upgrade}}}
+
+options:
+ -u --user USER   Use specified USER as committer.
+ -p --stamp TEXT  Append TEXT to all commit messages.
 """,
 
 "@unshelve" : """
 
 OPT_FILTER = {
 "init"    : ("force", "user", "stamp",),
+"upgrade" : ("user", "stamp",),
 "start"   : ("rev", "message", "stamp", "date", "user", "dirty",),
 "finish"  : ("commit", "message", "stamp", "date", "user", "erase", "onstream",),
 "list"    : ("closed",),
       ("k", "keyword",   '',    _("Do case-insensitive search for a given text. [log]"),                 _('TEXT'),),
       ("l", "limit",     '',    _("Limit number of changesets displayed. [log]"),                                  ),
       ("m", "message",   '',    _("Record TEXT as commit message. [start, finish, promote, abort]"),     _('TEXT'),),
-      ("p", "stamp",     '',    _("Append TEXT to all commit messages. [init, start, finish, promote,"
-                                  " rebase, abort]"),                                                    _('TEXT'),),
+      ("p", "stamp",     '',    _("Append TEXT to all commit messages. [init, upgrade, start, finish,"
+                                  " promote, rebase, abort]"),                                           _('TEXT'),),
       ("p", "patch",     False, _("Show patch. [log]"),                                                            ),
       ("r", "rev",       '',    _("Revision to start a new branch from. [start]"),                       _('REV'), ),
       ("r", "rev",       '',    _("Revision to promote to other branches. [promote]"),                   _('REV'), ),
       ("s", "onstream",  False, _("Act on stream. [finish, rebase, log, abort]"),                                  ),
       ("t", "tag",       '',    _("Tag the merging changeset with NAME. [promote]"),                     _('NAME'),),
-      ("u", "user",      '',    _("Use specified user as committer. [init, start, finish, promote]"),    _('USER'),),
+      ("u", "user",      '',    _("Use specified user as committer. [init, upgrade, start, finish,"
+                                  " promote]"),                                                          _('USER'),),
       ("u", "user",      '',    _("Show revisions committed by specified user. [log]"),                  _('USER'),),
      ],
      "hg flow {<stream> [<action> [<arg>]] | <command>} [<option>...]",