help: improve description of phases.checksubrepos setting stable
authorAngel Ezquerra <angel.ezquerra@gmail.com>
Wed, 29 Jan 2014 15:16:36 +0100
branchstable
changeset 20333 fa6cb300ded4
parent 20332 a959f7167077
child 20334 205599e31870
help: improve description of phases.checksubrepos setting The existing description was a bit hard to understand.
mercurial/help/config.txt
--- a/mercurial/help/config.txt	Thu Jan 30 11:52:38 2014 -0800
+++ b/mercurial/help/config.txt	Wed Jan 29 15:16:36 2014 +0100
@@ -946,13 +946,16 @@
     Default: draft
 
 ``checksubrepos``
+    Check the phase of the current revision of each subrepository. Allowed
+    values are "ignore", "follow" and "abort". For settings other than
+    "ignore", the phase of the current revision of each subrepository is
+    checked before committing the parent repository. If any of those phases is
+    greater than the phase of the parent repository (e.g. if a subrepo is in a
+    "secret" phase while the parent repo is in "draft" phase), the commit is
+    either aborted (if checksubrepos is set to "abort") or the higher phase is
+    used for the parent repository commit (if set to "follow").
+    Default: "follow"
 
-    Check phase of state in each subrepositories, allowed values are
-    "ignore", "follow" or "abort". For settings other than "ignore",
-    the phase of each subrepository commit is checked before committing
-    in the parent repository. If there is any greater phase than the parent
-    ("secret" vs "draft", for example), the commit is either aborted
-    with "abort" or the higher phase is used with "follow". Default: "follow".
 
 ``profiling``
 -------------