# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1255275495 14400
# Node ID 74aa03e429205f325164dbc5f3cf766e1c095559
# Parent  0071e116bfb41326f79a2bea5a07ed41ce32b08b
Start adding documentation for hg review --init

diff -r 0071e116bfb4 -r 74aa03e42920 review/extension_ui.py
--- a/review/extension_ui.py	Sun Oct 11 11:19:12 2009 -0400
+++ b/review/extension_ui.py	Sun Oct 11 11:38:15 2009 -0400
@@ -256,6 +256,33 @@
      ('Initializing code review for a repository'),
      (r"""
 hg review --init --remote-path PATH [--local-path PATH]
+    
+    Initialize code review for the current repository.
+    
+    When run for the first time in a project, it will do two things:
+    
+        * Create a new Mercurial repository called "code-review" in the root
+          of the current repository.  This name can be changed with the
+          --local-path option.
+        * 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.'
+    
+    This repository contains code review data such as comments and signoffs.
+    It is a normal Mercurial repository, so you can push and pull review data
+    to and from other clones of it to share your comments and signoffs.
+    
+    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.
+    
+    Examples:
+    
+        hg review --init --remote-path 'http://bitbucket.org/u/project-review'
+        hg review --init --remote-path '../project-review'
+        hg review --init --local-path 'review_data' --remote_path '../project-review-data'
+    
     """)),
     (['review-review'],
      ('Viewing code review data for changesets'),