sapling/doc
Patrick Mezard 1e4894d773 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
2011-02-15 22:25:48 +01:00
..
common.txt doc: link man pages to one another 2009-07-16 23:25:26 +02:00
gendoc.py doc: Capitalize the "options" header of mercurial commands 2011-02-05 14:37:25 +00:00
hg.1.txt gendoc: move section commands to module scope 2010-10-20 18:07:50 +02:00
hgignore.5.txt Update license to GPLv2+ 2010-01-19 22:20:08 -06:00
hgmanpage.py *: kill all unnecessary shebangs. 2010-10-26 12:18:39 +02:00
hgrc.5.txt commit: abort if a subrepo is modified and ui.commitsubrepos=no 2011-02-15 22:25:48 +01:00
Makefile runrst: add RSTARGS Makefile variable to allow customization 2010-12-01 09:46:11 +09:00
README doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
runrst runrst: try to be more helpful if docutils is not installed 2010-07-30 14:41:47 +09:00
style.css gendoc: added styling for extension TOC 2010-10-20 17:47:46 +02:00

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.