changeset 1340:57c5fb61e46a

Update documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 21 Feb 2011 00:49:38 +0200
parents f6028802b9a0
children b7c15bf36a5e
files docs/manual.sgml
diffstat 1 files changed, 31 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Tue Feb 15 20:55:51 2011 +0200
+++ b/docs/manual.sgml	Mon Feb 21 00:49:38 2011 +0200
@@ -443,22 +443,22 @@
 Mercurial client with following command:
 </para>
 
-<userinput>hg clone &hgrepourl; ggrtf</userinput>
+<userinput>hg clone &hgrepourl; dest_dir</userinput>
 
 <para>
 In which <emphasis>"clone"</emphasis> means making a local copy of the
-repository under directory named "ggrtf" (the last argument of the command).
+repository under directory <emphasis>dest_dir</emphasis>.
 </para>
 
 <para>
 You will most probably want to download the repository to some
-specific place, personally I prefer to use $HOME/ggrtf/ (aka "ggrtf/"
-subdirectory under user's homedir) under UNIX.
-<!--
-If you are using TF for Windows, it is probably wisest to place
-GgrTF's files under ... ????
--->
+specific place, personally I prefer to use ~/ggrtf/ (aka "ggrtf/"
+under user's home directory) under UNIX.
+Thus typically you would use following command:
 </para>
+
+<userinput>hg clone &hgrepourl; ~/ggrtf</userinput>
+
 </section>
 
 <section id="intro-updating"><title>Keeping up to date</title>
@@ -468,9 +468,9 @@
 the following commands:
 </para>
 
-<screen>cd ggrtf
+<userinput>cd ~/ggrtf
 hg pull
-hg update</screen>
+hg update</userinput>
 
 <para>
 If you have made changes to the files, Mercurial will try to merge them
@@ -489,6 +489,27 @@
 
 </section>
 
+<section id="intro-upgrading-from-svn"><title>Upgrading from Subversion repo to Mercurial</title>
+<para>
+Previously we used <ulink linkend="">Subversion</ulink> as our version
+control system, before migrating to Mercurial. If you have used the svn
+version, you can switch by deleting or renaming the old checkout working
+directory of Subversion. For example, if you have local changes, you can do:
+
+<userinput>mv ~/ggrtf ~/old-ggrtf</userinput>
+<userinput>hg clone &hgrepourl; ~/ggrtf</userinput>
+<userinput>cp ~/old-ggrtf/* ~/ggrtf/</userinput>
+
+Alternatively, if you do not have any changes of your own, you can just delete the old Subversion checkout
+as follows:
+
+<userinput>rm -fR ~/ggrtf</userinput>
+<userinput>hg clone &hgrepourl; ~/ggrtf</userinput>
+
+</para>
+
+</section>
+
 </section>
 
 </chapter>