--- a/docs/cli.rst Sat Jul 03 15:57:40 2010 -0400
+++ b/docs/cli.rst Sat Jul 03 16:18:43 2010 -0400
@@ -17,50 +17,62 @@
``review``
----------
-View code review data for a changeset.
+View code review data for a changeset. Usage::
-**USAGE:** ``hg review [-r REV] [-U CONTEXT] [--quiet] [FILE]``
+ hg review [-r REV] [-U CONTEXT] [--quiet] [FILE]
Diffs of all changed files will be shown with comments inline.
The line numbers printed are the ones that should be used to add line-level
comments.
-Relevant options:
-
+Options:
``--unified VALUE``
- The number of lines of context to show for diffs in this changeset.
-
- Default: ``5``
+ The number of lines of context to show for diffs in this changeset
+ (default: ``5``).
``--rev VALUE``
- The revision to show.
-
- Default: ``.`` (the parent of the working directory)
+ The revision to show (default: ``.``).
``--quiet``
- Do not show diffs -- only show review-level comments and signoffs.
-
- Default: ``false``
+ Do not show diffs -- only show review-level comments and signoffs (default:
+ ``false``).
``--verbose``
- Show the short identifier of each comment and signoff (mainly for use with
- the :ref:`edit <c-edit>` subcommand).
-
- Default: ``false``
+ Show the short identifier of each comment and signoff, mainly for use with
+ the :ref:`edit <c-edit>` subcommand (default: ``false``).
``--debug``
- Show the full identifier of each comment and signoff (mainly for use with
- the :ref:`edit <c-edit>` subcommand).
-
- Default: ``false``
+ Show the full identifier of each comment and signoff, mainly for use with
+ the :ref:`edit <c-edit>` subcommand (default: ``false``).
.. _c-init:
``--init``
----------
+Initialize code review for a repository. Usage::
+
+ hg review --init --remote-path PATH
+
+When run for the first time in a project, it will do two things:
+
+* Create a new repository to hold the review data at ``.hg/review/``.
+
+* Create and ``hg add`` a ``.hgreview`` file in the current repository. You
+ will need to commit this file yourself with: ``hg commmit .hgreview -m
+ 'initialize code review data'``
+
+The ``--remote-path`` option is required and specifies the path where the
+canonical code review data for this project will live. This is the path that
+will be cloned when someone else runs ``hg review --init`` on the project.
+
+Options:
+
+``--remote-path VALUE``
+ The URL to the public code review data repository.
+
.. _c-comment: