4bad4dc4dddc

Add some documentation for hg review --signoff
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sat, 10 Oct 2009 19:54:18 -0400
parents deb1059d6425
children 7cd4514b49f4
branches/tags (none)
files review/extension_ui.py

Changes

--- a/review/extension_ui.py	Sat Oct 10 19:45:45 2009 -0400
+++ b/review/extension_ui.py	Sat Oct 10 19:54:18 2009 -0400
@@ -287,6 +287,22 @@
     (['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.
+    
+    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.
+    
+    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!'
     
     ''')),
 )
\ No newline at end of file