f82c3447cf49 initial-docs
docs: start the CLI doc
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Sat, 03 Jul 2010 15:57:40 -0400 |
parents | bb3928ffbda3 |
children | 3a88cfd5c8b7 |
branches/tags | initial-docs |
files | docs/cli.rst |
Changes
--- a/docs/cli.rst Sat Jul 03 15:39:14 2010 -0400 +++ b/docs/cli.rst Sat Jul 03 15:57:40 2010 -0400 @@ -1,22 +1,92 @@ Command Line Interface ====================== -hg-review provides a command line interface. +hg-review provides a command line interface. Except for initializing the review +data, starting the web ui, and possibly some scripting, you'll probably want to +use the :doc:`web interface </webui>` for most tasks. + +When you enable the hg-review extension Mercurial will gain a new command: +``review``. This command on its own will display review data for a changeset, +but it also has several subcommands detailed below. + +You can always get help on a given topic right from the command line with +``hg help review`` or ``hg help review-topic``. + +.. _c-review: ``review`` ---------- +View code review data for a changeset. + +**USAGE:** ``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: + + +``--unified VALUE`` + 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) + +``--quiet`` + 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`` + +``--debug`` + Show the full identifier of each comment and signoff (mainly for use with + the :ref:`edit <c-edit>` subcommand). + + Default: ``false`` + +.. _c-init: + +``--init`` +---------- + + +.. _c-comment: + ``--comment`` ------------- + +.. _c-signoff: + ``--signoff`` ------------- + +.. _c-edit: + ``--edit`` ---------- + +.. _c-check: + ``--check`` ----------- + +.. _c-web: + ``--web`` ---------