subrepo: update help for commit to reflect new default behavior stable
authorDavid M. Carr <david@carrclan.us>
Thu, 03 Nov 2011 23:11:40 -0400
branchstable
changeset 15427 2a3ab9e81a3e
parent 15425 09a1dff3aff7
child 15428 da81da6caa6b
subrepo: update help for commit to reflect new default behavior Update the subrepo help to be consistent with the new default behavior, which is to abort if any subrepo is dirty.
mercurial/help/subrepos.txt
--- a/mercurial/help/subrepos.txt	Thu Nov 03 10:52:58 2011 -0200
+++ b/mercurial/help/subrepos.txt	Thu Nov 03 23:11:40 2011 -0400
@@ -80,12 +80,13 @@
     -S/--subrepos is specified.
 
 :commit: commit creates a consistent snapshot of the state of the
-    entire project and its subrepositories. It does this by first
-    attempting to commit all modified subrepositories, then recording
-    their state and finally committing it in the parent
-    repository. Mercurial can be made to abort if any subrepository
-    content is modified by setting "ui.commitsubrepos=no" in a
-    configuration file (see :hg:`help config`).
+    entire project and its subrepositories. If any subrepositories
+    have been modified, Mercurial will abort.  Mercurial can be made
+    to instead commit all modified subrepositories by specifying
+    -S/--subrepos, or setting "ui.commitsubrepos=True" in a
+    configuration file (see :hg:`help config`).  After there are no
+    longer any modified subrepositories, it records their state and
+    finally commits it in the parent repository.
 
 :diff: diff does not recurse in subrepos unless -S/--subrepos is
     specified. Changes are displayed as usual, on the subrepositories