changeset 4972:b52a1ccee927

docs/usage: reword information on Mercurial subrepository support
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Sun, 05 Apr 2015 21:05:12 +0200
parents 9cef5a168b88
children 8d065db04909
files docs/usage/vcs_support.rst
diffstat 1 files changed, 17 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/docs/usage/vcs_support.rst	Sun Apr 05 21:03:42 2015 +0200
+++ b/docs/usage/vcs_support.rst	Sun Apr 05 21:05:12 2015 +0200
@@ -49,36 +49,34 @@
 
 Working with Mercurial subrepositories
 ``````````````````````````````````````
-Example usage of Subrepos with Kallithea::
+This section explains how to use Mercurial subrepositories_ in Kallithea.
+
+Example usage::
 
     ## init a simple repo
-    hg init repo1
-    cd repo1
-    echo "file1" > file1
-    hg add file1
-    hg ci --message "initial file 1"
+    hg init mainrepo
+    cd mainrepo
+    echo "file" > file
+    hg add file
+    hg ci --message "initial file"
 
-    #clone subrepo we want to add
+    # clone subrepo we want to add from Kallithea
     hg clone http://kallithea.local/subrepo
 
-    ## use path like url to existing repo in Kallithea
+    ## specify URL to existing repo in Kallithea as subrepository path
     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.
+In the file list of a clone of ``mainrepo`` you will see a connected
+subrepository at the revision it was cloned with. Clicking on the
+subrepository link sends you to the proper repository in Kallithea.
 
-Cloning ``repo1`` will also clone the attached subrepository.
+Cloning ``mainrepo`` 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.
+Next we can edit the subrepository data, and push back to Kallithea. This will
+update both repositories.
 
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
+.. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/