206a678a3459 initial-docs

docs/cli: more cli documentation
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 05 Jul 2010 22:21:16 -0400
parents 47104395a16d
children d142aacf4480
branches/tags initial-docs
files docs/cli.rst

Changes

--- a/docs/cli.rst	Mon Jul 05 22:04:18 2010 -0400
+++ b/docs/cli.rst	Mon Jul 05 22:21:16 2010 -0400
@@ -79,12 +79,70 @@
 ``--comment``
 -------------
 
+Add a code review comment for a changeset. Usage::
+
+    hg review --comment [-m MESSAGE] [--mdown] [-r REV] [-l LINES] [FILE]
+
+If no files are given the comment will be attached to the changeset as a whole.
+
+If one or more files are given but no lines are given, the comment will be
+attached to each file as a whole.
+
+If a file is given and lines are given the comment will be attached to those
+specific lines. Lines should be specified as a comma-separated list of line
+numbers (as numbered in the output of "hg review"), such as ``3`` or ``2,3``.
+
+Options:
+
+``--rev VALUE``
+    The revision to add a comment to (default: ``.``).
+
+``--lines VALUE``
+    Comment on the given lines (specified as a comma-separated list of line
+    numbers) of the file (default: ``None``).
+
+``--message VALUE``
+    Use ``VALUE`` as the comment instead of opening an editor (default:
+    ``None`` (i.e. "open an editor")).
+
+``--mdown``
+    Use Markdown to format the comment (default: ``False``).
+
 
 .. _c-signoff:
 
 ``--signoff``
 -------------
 
+Add a code review signoff for a changeset. Usage::
+
+    hg review --signoff [-m MESSAGE] [--mdown] [--yes | --no] [-r REV]
+
+The ``--yes`` and ``--no`` options can be used to indicate whether you think the
+changeset is "good" or "bad".
+
+It's up to the collaborators of each individual project to decide exactly what
+that means.  If neither option is given the signoff will be marked as
+"neutral".
+
+Options:
+
+``--rev VALUE``
+    The revision to sign off on (default: ``.``).
+
+``--yes``
+    Sign off as "yes" for the changeset (default: ``False`` (i.e. "neutral")).
+
+``--no``
+    Sign off as "no" for the changeset (default: ``False`` (i.e. "neutral")).
+
+``--message VALUE``
+    Use ``VALUE`` as the signoff message instead of opening an editor (default:
+    ``None`` (i.e. "open an editor")).
+
+``--mdown``
+    Use Markdown to format the signoff message (default: ``False``).
+
 
 .. _c-edit: