bb3928ffbda3 initial-docs
docs: minor cleanup
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Sat, 03 Jul 2010 15:39:14 -0400 |
parents | c28a2dae28ef |
children | f82c3447cf49 |
branches/tags | initial-docs |
files | docs/cli.rst docs/overview.rst |
Changes
--- a/docs/cli.rst Sat Jul 03 15:33:59 2010 -0400 +++ b/docs/cli.rst Sat Jul 03 15:39:14 2010 -0400 @@ -3,8 +3,8 @@ hg-review provides a command line interface. -review ------- +``review`` +---------- ``--comment`` ------------- @@ -12,6 +12,9 @@ ``--signoff`` ------------- +``--edit`` +---------- + ``--check`` -----------
--- a/docs/overview.rst Sat Jul 03 15:33:59 2010 -0400 +++ b/docs/overview.rst Sat Jul 03 15:39:14 2010 -0400 @@ -31,21 +31,25 @@ ----- The easiest way to work with hg-review is with the :doc:`web interface -</webui>`. There's also a command-line interface, but it's really easiest to -work with the web ui. +</webui>`. There's also a :doc:`command-line interface </cli>`, but it's +easiest to work with the web interface. Projects with Existing Code Reviews ''''''''''''''''''''''''''''''''''' -If you want to work with a repository that already has code review set up, all -you need to do is cd into that repository, run ``hg review --init`` to pull -down the review data, and then run ``hg review --web`` to fire up the web ui. +If you want to work with a repository that already has code review set up all +you need to do is cd into that repository, pull down the review data, and fire +up the web ui:: + + cd ~/src/someproject + hg review --init + hg review --web Once that's done you can visit http://localhost:8080/ in your browser to start reviewing. You should read over the :doc:`concepts </concepts>` documentation to make sure -you know how hg-review works, and the :doc:`web interface </webui>` +you know how hg-review works and the :doc:`web interface </webui>` documentation for a quick tour of how to use the web UI. Projects without Existing Code Reviews