changeset 1322:903f92f4b918

Add note about sending patches.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 13 Feb 2011 10:24:44 +0200
parents f0772cb67e61
children bcfde549790f
files docs/manual.sgml
diffstat 1 files changed, 25 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Wed Feb 09 00:16:49 2011 +0200
+++ b/docs/manual.sgml	Sun Feb 13 10:24:44 2011 +0200
@@ -6,6 +6,7 @@
 <!ENTITY ggr "<ulink url='http://tnsp.org/~ccr/'>Matti Hämäläinen</ulink> (&finger Ggr;)">
 <!ENTITY tfurl "<ulink url='http://tinyfugue.sf.net/'>TinyFugue</ulink>">
 <!ENTITY homeurl "<ulink url='http://tnsp.org/~ccr/ggrtf/'>http://tnsp.org/~ccr/ggrtf/</ulink>">
+<!ENTITY hgrepourl "http://dev.pupunen.net/hg/ggrtf/">
 <!ENTITY hgrepo "<ulink url='http://dev.pupunen.net/hg/ggrtf/'>Mercurial-repository</ulink>">
 <!ENTITY hgurl "<ulink url='http://mercurial.selenic.com/'>Mercurial</ulink>">
 <!ENTITY batmudurl "<ulink url='http://www.bat.org/'>BatMUD</ulink>">
@@ -432,7 +433,7 @@
 <para>
 GgrTF's Mercurial repository is graciously hosted by &jeskko;
 at &pupuneturl;, and is available from following location:
-<ulink url="http://dev.pupunen.net/hg/ggrtf/">http://dev.pupunen.net/hg/ggrtf/</ulink>.
+<ulink url="&hgrepourl;">&hgrepourl;</ulink>.
 The same URL can be used with a web browser to browse the repository history.
 </para>
 
@@ -442,7 +443,7 @@
 Mercurial client with following command:
 </para>
 
-<userinput>hg clone http://dev.pupunen.net/hg/ggrtf/ ggrtf</userinput>
+<userinput>hg clone &hgrepourl; ggrtf</userinput>
 
 <para>
 In which <emphasis>"clone"</emphasis> means making a local copy of the
@@ -3231,6 +3232,28 @@
  <listitem><para></para></listitem>
 -->
 </itemizedlist>
+
+<section id="patches"><title>Sending patches/corrections</title>
+<para>
+If you have prepared a fix for some bug or a new feature, you can send us a patch.
+<emphasis>A changeset patch made against current Mercurial repository head/tip is highly preferred</emphasis>,
+short instructions on how to do that can be found from <ulink linkend="http://mercurial.selenic.com/guide/">Mercurial guide</ulink>.
+You need to at the very least set up your username, etc.
+</para>
+<screen>
+# 1) Make changes to files
+$EDITOR ggrtf.tf
+
+# 2) Commit related changes to a changeset your local repository
+hg ci [filenames of changed files or nothing, if you wish to commit everything]
+
+# 3) Repeat steps 1 to 2 until satisfied
+
+# 4) Export your local changes to a bundle
+hg bundle &hgrepourl;
+</screen>
+</section>
+
 </appendix>
 
 <!-- ================================================ -->