docs/cli: add docs for --edit
author |
Steve Losh <steve@stevelosh.com> |
date |
Mon, 05 Jul 2010 23:30:40 -0400 |
parents |
e86b336ed78f
|
children |
98c12a5d5aec
|
branches/tags |
initial-docs |
files |
docs/cli.rst |
Changes
--- a/docs/cli.rst Mon Jul 05 23:17:11 2010 -0400
+++ b/docs/cli.rst Mon Jul 05 23:30:40 2010 -0400
@@ -149,6 +149,39 @@
``--edit``
----------
+Edit a comment or signoff. 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.
+
+``--message VALUE``
+ Replace the comment or signoff message with VALUE (default: ``None`` (i.e.
+ "open an editor")).
+
+``--mdown``
+ Use Markdown to format the comment or signoff message (default: ``False``
+ (i.e. "Use the same formatting the item already has)).
+
+``--lines``
+ The line(s) of the file to comment on (default: ``None`` (i.e. "use the
+ same line the comment already has)). Returns an error if you're editing
+ a signoff or a review-level comment.
+
+``--yes``
+ Change the signoff to state the the changeset is "good" (default:
+ ``False``). Returns an error if you are not editing a signoff.
+
+``--no``
+ Change the signoff to state the the changeset is "bad" (default:
+ ``False``). Returns an error if you are not editing a signoff.
+
.. _c-check: