changeset 765:62c9e6bd2ca7

docs: document new config knob for externals support
author Augie Fackler <durin42@gmail.com>
date Sun, 28 Nov 2010 20:37:19 -0600
parents bc5c176b63eb
children 124cd25de4ef
files hgsubversion/help/subversion.rst
diffstat 1 files changed, 14 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/hgsubversion/help/subversion.rst
+++ b/hgsubversion/help/subversion.rst
@@ -98,8 +98,9 @@ accepted by several Mercurial commands f
 Support for externals
 ---------------------
 
-When using a standard layout, ``svn:externals`` properties are serialized into
-a single ``.hgsvnexternals`` file having the following syntax::
+When using a standard layout, ``svn:externals`` properties are (by
+default) serialized into a single ``.hgsvnexternals`` file having the
+following syntax::
 
   [.]
    common1 http://path/to/external/svn/repo1
@@ -124,6 +125,11 @@ will not be pushed to the related Subver
 contents **will** be used to update ``svn:externals`` properties on the
 related Subversion repository.
 
+Alternatively, one can use the ``hgsubversion.externals`` in hgrc to
+specify ``subrepos`` as the externals mode. In this mode, ``.hgsub``
+and ``.hgsubstate`` files will be used instead of
+``.hgsvnexternals``. This feature requires Mercurial 1.7.1 or later.
+
 Limitations
 -----------
 
@@ -231,6 +237,12 @@ settings:
     using very old versions of Subversion, and hgsubversion falls back to it
     when necessary.
 
+  ``hgsubversion.externals``
+    Set to ``subrepos`` to switch to subrepos-based externals support
+    (requires Mercurial 1.7.1 or later.) Default is ``svnexternals``,
+    which uses a custom hgsubversion-specific format and works on
+    older versions of Mercurial.
+
 The following options only have an effect on the initial clone of a repository:
 
   ``hgsubversion.layout``