6930dfc9918a

Add documentation for hg review
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sun, 11 Oct 2009 10:37:57 -0400
parents 8fd7562a81ad
children 4ede1c231525
branches/tags (none)
files review/extension_ui.py

Changes

--- a/review/extension_ui.py	Sun Oct 11 10:28:08 2009 -0400
+++ b/review/extension_ui.py	Sun Oct 11 10:37:57 2009 -0400
@@ -257,6 +257,18 @@
     (['review-review', 'review-review'],
      ('Viewing code review data for changesets'),
      (r"""
+hg review [-r REV] [-U CONTEXT] [--quiet] [FILE]
+    
+    Show code review information about a specific revision. Diffs of all
+    changed files will be shown, and the line numbers printed are the ones
+    that should be used with 'hg review --comment --lines LINES FILE'.
+    
+    If no revision is given, the current parent of the working directory
+    will be shown.
+    
+    The number of lines of context in diffs can be changed with the -U option.
+    If any FILEs are given, only those diffs will be shown. If --quiet is used
+    no diffs will be shown.
     
     """)),
     (['review-comment', 'review-comment'],
@@ -287,22 +299,25 @@
     (['review-signoff', 'review-signoff'],
      ('Adding code review signoffs for changesets'),
      (r"""
-hg review --signoff -m MESSAGE [--yes | --no] [-r REV]
-    
-    Sign off on a changeset.
+hg review --signoff -m MESSAGE [--yes | --no] [-r REV] [--force]
     
     If no revision is given, the current parent of the working directory
     will be used.
     
     The --yes and --no options can be used to indicate whether you think
     the changeset is "good" or "bad".  It's up to the collaborators of each
-    individual project to decide exactly what that means.
+    individual project to decide exactly what that means.  If neither option
+    is given the signoff will be marked as "neutral".
+    
+    If you've already signed off on a changeset, you can use --force to
+    overwrite your previous signoff with a new one.
     
     Examples:
     
         hg review --signoff -m 'I do not work on this part of the code.'
         hg review --signoff --yes -m 'Thanks, this change looks good.'
         hg review --signoff --no -m 'This would break backwards compatibility!'
+        hg review --signoff --yes --force -m 'Nevermind, this is fine.'
     
     """)),
 )
\ No newline at end of file