docs/cli: add docs for --check
author |
Steve Losh <steve@stevelosh.com> |
date |
Mon, 05 Jul 2010 22:34:40 -0400 |
parents |
206a678a3459
|
children |
f54f891c2b7f
|
branches/tags |
initial-docs |
files |
docs/cli.rst |
Changes
--- a/docs/cli.rst Mon Jul 05 22:21:16 2010 -0400
+++ b/docs/cli.rst Mon Jul 05 22:34:40 2010 -0400
@@ -155,6 +155,37 @@
``--check``
-----------
+Check the review status of a changeset. Usage::
+
+ USAGE: hg review --check [-r REV] [--no-nos] [--yeses NUM] [--seen]
+
+Check that the given changeset "passes" the given tests of review status. If no
+tests are given an error is returned.
+
+Tests are checked in the following order:
+
+- ``--no-nos``
+- ``--yeses``
+- ``--seen``
+
+If any tests fail the command returns a status of 1 with a message describing
+the failure on stderr, otherwise it returns 0 and prints nothing.
+
+``--rev VALUE``
+ The revision to check (default: ``.``).
+
+``--no-nos``
+ Ensure this revision does *not* have any signoffs of "no" (default:
+ ``False`` (i.e. "Don't perform this check")).
+
+``--yeses VALUE``
+ Ensure this revision has at least VALUE signoffs of "yes" (default:
+ ``None`` (i.e. "Don't perform this check").
+
+``--seen``
+ Ensure this revision has at least one comment or signoff (default:
+ ``False`` (i.e. "Don't perform this check")).
+
.. _c-web: