hgrc: document [subpaths] section stable
authorPatrick Mezard <pmezard@gmail.com>
Sun, 24 Oct 2010 18:39:02 +0200
branchstable
changeset 12827 042bc18dee4b
parent 12826 4d622380ab39
child 12828 af1006d2f970
hgrc: document [subpaths] section
doc/hgrc.5.txt
--- a/doc/hgrc.5.txt	Sun Oct 24 18:37:59 2010 +0200
+++ b/doc/hgrc.5.txt	Sun Oct 24 18:39:02 2010 +0200
@@ -797,6 +797,23 @@
     checking that all new file revisions specified in manifests are
     present. Default is False.
 
+``subpaths``
+""""""""""""
+Defines subrepositories source locations rewriting rules of the form::
+
+    <pattern> = <replacement>
+
+Where ``pattern`` is a regular expression matching the source and
+``replacement`` is the replacement string used to rewrite it. Groups
+can be matched in ``pattern`` and referenced in ``replacements``. For
+instance::
+
+    http://server/(.*)-hg/ = http://hg.server/\1/
+
+rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
+
+All patterns are applied in definition order.
+
 ``trusted``
 """""""""""