# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1255218345 14400
# Node ID deb1059d6425f1ba531b39a9b457c849660e7c9c
# Parent  1ed53449d65092455e11ef138bda344a8b401f52
Add some documentation for hg review --comment

diff -r 1ed53449d650 -r deb1059d6425 review/extension_ui.py
--- a/review/extension_ui.py	Sat Oct 10 19:18:30 2009 -0400
+++ b/review/extension_ui.py	Sat Oct 10 19:45:45 2009 -0400
@@ -252,21 +252,41 @@
     (['review-init', 'review-init'],
      ('Initializing code review for a repository'),
      (r'''
-     
+    
     ''')),
     (['review-review', 'review-review'],
      ('Viewing code review data for changesets'),
      (r'''
-     
+    
     ''')),
     (['review-comment', 'review-comment'],
      ('Adding code review comments for changesets'),
      (r'''
-     
+    hg review --comment -m MESSAGE [-r REV] [-l LINES] [FILE]
+    
+    If no revision is given, the current parent of the working directory
+    will be used.
+    
+    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 the each file as a whole.
+    
+    If a FILE is given and LINES is given the comment will be attached to
+    those specific lines.  LINES should be a comma-separated list of line
+    numbers (as numbered in the output of 'hg review'), such as '3' or '2,3'
+    
+    Examples:
+    
+        hg review --comment -m 'This changeset needs to go in branch X.'
+        hg review --comment -m 'This file should just be deleted.' script.py
+        hg review --comment -m 'Trailing whitespace!' --lines 1,2,30 utils.py
+    
     ''')),
     (['review-signoff', 'review-signoff'],
      ('Adding code review signoffs for changesets'),
      (r'''
-     
+    
     ''')),
 )
\ No newline at end of file