docs/usage: move Mercurial subrepository info to VCS support page

This commit moves the information verbatim, text changes will be done in a
subsequent commit.

docs/index.rst

@@ -1,71 +1,70 b''
 .. _index:
 
 Administrators Guide
 --------------------
 
 **Readme**
 
 .. toctree::
    :maxdepth: 1
 
    readme
 
 **Installation**
 
 .. toctree::
    :maxdepth: 1
 
    installation
    installation_win
    installation_win_old
    installation_iis
    setup
 
 **Usage**
 
 .. toctree::
    :maxdepth: 1
 
    usage/general
    usage/vcs_support
    usage/performance
    usage/locking
    usage/statistics
    usage/backup
-   usage/subrepos
    usage/debugging
    usage/troubleshooting
 
 **Develop**
 
 .. toctree::
    :maxdepth: 1
 
    contributing
    changelog
 
 **API**
 
 .. toctree::
    :maxdepth: 1
 
    api/api
    api/models
 
 
 Other topics
 ------------
 
 * :ref:`genindex`
 * :ref:`search`
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs

docs/usage/vcs_support.rst

@@ -1,49 +1,84 b''
 .. _vcs_support:
 
 ===============================
 Version control systems support
 ===============================
 
 Kallithea supports Git and Mercurial repositories out-of-the-box.
 For Git, you do need the ``git`` command line client installed on the server.
 
 You can always disable Git or Mercurial support by editing the
 file ``kallithea/__init__.py`` and commenting out the backend.
 
 .. code-block:: python
 
    BACKENDS = {
        'hg': 'Mercurial repository',
        #'git': 'Git repository',
    }
 
 Git support
 -----------
 
 Web server with chunked encoding
 ````````````````````````````````
 Large Git pushes require an HTTP server with support for
 chunked encoding for POST. The Python web servers waitress_ and
 gunicorn_ (Linux only) can be used. By default, Kallithea uses
 waitress_ for `paster serve` instead of the built-in `paste` WSGI
 server.
 
 The default paste server is controlled in the .ini file::
 
     use = egg:waitress#main
 
 or::
 
     use = egg:gunicorn#main
 
 
 Also make sure to comment out the following options::
 
     threadpool_workers =
     threadpool_max_requests =
     use_threadpool =
 
 
+Mercurial support
+-----------------
+
+Working with Mercurial subrepositories
+``````````````````````````````````````
+Example usage of Subrepos with Kallithea::
+
+    ## init a simple repo
+    hg init repo1
+    cd repo1
+    echo "file1" > file1
+    hg add file1
+    hg ci --message "initial file 1"
+
+    #clone subrepo we want to add
+    hg clone http://kallithea.local/subrepo
+
+    ## use path like url to existing repo in Kallithea
+    echo "subrepo = http://kallithea.local/subrepo" > .hgsub
+
+    hg add .hgsub
+    hg ci --message "added remote subrepo"
+
+
+In the file list of a clone of ``repo1`` you will see a connected
+subrepo at the revision it was at during cloning. Clicking in
+subrepos link should send you to the proper repository in Kallithea.
+
+Cloning ``repo1`` will also clone the attached subrepository.
+
+Next we can edit the subrepo data, and push back to Kallithea. This will update
+both of the repositories.
+
+See http://mercurial.aragost.com/kick-start/en/subrepositories/ for more
+information about subrepositories.
 
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn