e86b336ed78f initial-docs

Merge with default.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 05 Jul 2010 23:17:11 -0400
parents d303f56078eb (current diff) 48eb55088a67 (diff)
children 6800923435cd
branches/tags initial-docs
files

Changes

--- a/review/cli.py	Mon Jul 05 23:06:10 2010 -0400
+++ b/review/cli.py	Mon Jul 05 23:17:11 2010 -0400
@@ -351,6 +351,7 @@
     - hg help review-signoff
     - hg help review-check
     - hg help review-web
+    - hg help review-edit
 
     Once you've reviewed some changesets don't forget to push your comments and
     signoffs so other people can view them.
@@ -416,6 +417,7 @@
     (['review-signoff'], ('Adding code review signoffs for changesets'), (helps.SIGNOFF)),
     (['review-check'], ('Checking the review status of changesets'), (helps.CHECK)),
     (['review-web'], ('Using the web interface to review changesets'), (helps.WEB)),
+    (['review-edit'], ('Editing code review comments and signoffs'), (helps.EDIT)),
 )
 
 colortable = {
--- a/review/helps.py	Mon Jul 05 23:06:10 2010 -0400
+++ b/review/helps.py	Mon Jul 05 23:17:11 2010 -0400
@@ -153,3 +153,22 @@
 If ``--port`` is given the web interface will listen on the given port.
 
 """
+
+EDIT = r"""
+USAGE: hg review --edit IDENTIFIER [--yes | --no] [-m MESSAGE] [-l LINES] [--mdown] [FILE]
+
+Edit the comment or changeset with the given identifier.
+
+You can find the identifier of the item you would like to edit by running ``hg
+review --verbose`` to display identifiers.
+
+Any other options given (such as ``--message``, ``--yes`` or filenames) will
+replace the content of the item you edit.
+
+Examples::
+
+    hg review --edit aaabbb111333 -m "This is fine."
+    hg review --edit aaabbb111333 -m "These lines are bad." -l 2,3,4
+    hg review --edit aaabbb111333 --no -m "I've changed my mind, this is bad."
+
+"""