Mercurial > hg > batmud > ggrtf
changeset 1346:de37c79098cc rel-0_6_15_4
Updated documentation.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 28 Feb 2011 15:09:49 +0200 |
parents | 481fa6487a24 |
children | 1070b63b94d0 |
files | docs/manual.sgml |
diffstat | 1 files changed, 37 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Mon Feb 28 14:31:45 2011 +0200 +++ b/docs/manual.sgml Mon Feb 28 15:09:49 2011 +0200 @@ -405,7 +405,7 @@ </section> -<section id="inst-mercurial"><title>Mercurial-repository</title> +<section id="inst-mercurial"><title>Development version</title> <para> Another way to get GgrTF is to go to the very source, the development source repository. This repository contains the latest @@ -418,7 +418,7 @@ </para> <para> -New features and new bugfixes may sometimes be worth taking the risk. +New features and bugfixes may sometimes be worth taking the risk. On the other hand, it is all up to what you want and whether you can manage to handle the possibly arising problems. </para> @@ -434,7 +434,7 @@ GgrTF's Mercurial repository is graciously hosted by &jeskko; at &pupuneturl;, and is available from following location: <ulink url="&hgrepourl;">&hgrepourl;</ulink>. -The same URL can be used with a web browser to browse the repository history. +The same URL can be used with a web browser to browse version history. </para> <section id="intro-checking-out"><title>Checking out</title> @@ -459,6 +459,25 @@ <userinput>hg clone &hgrepourl; ~/ggrtf</userinput> +<para> +If you are using Windows, and wish to use the development version, you +can use the regular Mercurial command line client, or a GUI interface +such as <ulink linkend="http://tortoisehg.bitbucket.org/">TortoiseHg</ulink>. +</para> + +<para> +The procedures for cloning and updating your local copy of the repository +are otherwise similar, except the directory/folder path is different, +under Windows XP the path would be <emphasis>C:\Documents and Settings\<username>\ggrtf\</emphasis>. +For example, if your username is "Ggr", you could use the following command: +</para> + +<userinput>hg clone &hgrepourl; "C:\Documents and Settings\Ggr\ggrtf\"</userinput> + +<para> +Under Windows Vista and 7, the path is of the format <emphasis>C:\Users\<username>\</emphasis> +</para> + </section> <section id="intro-updating"><title>Keeping up to date</title> @@ -468,17 +487,12 @@ the following commands: </para> -<userinput>cd ~/ggrtf -hg pull -hg update</userinput> - -<para> -If you have made changes to the files, Mercurial will try to merge them -with changes that have occured in the main repository. Sometimes the -changes may be interfering with each other and cause a merging error. -You must fix these problems by hand, please refer to Mercurial -documentation for more information and tips. -</para> +<userinput>cd ~/ggrtf</userinput> + +<userinput>hg pull</userinput> + +<userinput>hg update</userinput> + <para> Notice that since Mercurial is a distributed version management system, you can easily @@ -486,6 +500,12 @@ and then, instead of using 'pull' and 'update', you can use 'hg fetch' to merge your local changesets automatically. Refer to Mercurial documentation. </para> +<para> +If you plan on making modifications to GgrTF, it is recommended that you familiarize +yourself with the basics of Mercurial workflow, making commits, fetching, etc. It +will help you with maintaining your changes locally or sending patches to us. +</para> + </section> @@ -549,7 +569,9 @@ <listitem><para> DruWare Win32 port of TF: - <emphasis></emphasis> + Windows XP/2k/NT - <emphasis>C:\Documents and Settings\username\tfrc</emphasis>, + + Windows 7/Vista - <emphasis>C:\Users\username\tfrc</emphasis> </para></listitem> </itemizedlist>