diff mercurial/help/subrepos.txt @ 13411:d4de90a612f7

commit: abort if a subrepo is modified and ui.commitsubrepos=no

The default behaviour is to commit subrepositories with uncommitted changes. In
my experience this is usually undesirable:

- Changes to dependencies are often debugging leftovers
- Real changes should generally be applied on the source project directly,
  tested then committed. This is not always possible, subversion subrepos may
  include only a small part of the source project, without the tests.

Setting ui.commitsubrepos=no will now abort commits containing such modified
subrepositories like:

  $ hg --config ui.commitsubrepos=no ci -m msg
  abort: uncommitted changes in subrepo sub

I ruled out the hook solution because it does not easily take --include/exclude
options in account. Also, my main concern is whether this flag could cause
problems with extensions. If there are legitimate reasons for callers to
override this behaviour (I could not find any), they might either override at ui
level, or we could add an argument to localrepo.commit() later.

v2:
- Renamed ui.commitsubs to ui.commitsubrepos
- Mention the configuration entry in hg help subrepos

--- a/mercurial/help/subrepos.txt	Tue Feb 15 16:19:11 2011 -0600
+++ b/mercurial/help/subrepos.txt	Tue Feb 15 22:25:48 2011 +0100
@@ -78,7 +78,10 @@
 :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.
+    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`).
 
 :diff: diff does not recurse in subrepos unless -S/--subrepos is
     specified. Changes are displayed as usual, on the subrepositories