From 34d0347a72f22683a5d32bf07211182db330cf07 Mon Sep 17 00:00:00 2001
From: Guido Guenther <agx@sigxcpu.org>
Date: Wed, 17 Oct 2007 20:06:06 +0200
Subject: Documentation updates

---
 docs/chapters/releases.sgml | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

(limited to 'docs/chapters/releases.sgml')

diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml
index 2ee3aea9..07195a15 100644
--- a/docs/chapters/releases.sgml
+++ b/docs/chapters/releases.sgml
@@ -8,11 +8,11 @@
     release or anytime between releases.</para> 
     <para>
     The simplest way is doing all the changes to the
-    <emphasis>debian</emphasis>-branch without touching
+    <option>debian-branch</option> without touching
     <emphasis>debian/changelog</emphasis> at all. Then, when done, do:
     </para>
 <screen>
-&git-dch; --release
+&git-dch; <option>--release</option>
 </screen>
     <para> This will look up the latest released version in the changelog,
     increment the version in the &debian; changelog, generate changelog
@@ -22,7 +22,7 @@
     <para>
     But what if you want to have an (unreleased) snapshot for intermediate testing:
 <screen>
-&git-dch; --snapshot
+&git-dch; <option>--snapshot</option>
 </screen>
    <para>will generate a snapshot release with a specially crafted version number
    and a warning in the changelog that this is a snapshort release:
@@ -39,19 +39,19 @@ git-buildpackage (0.3.7~1.gbp470ce2) UNRELEASED; urgency=low
    commit id of the current branch head, &git-dch; can figure out what to
    append to the changelog by itself:
 <screen>
-&git-dch; --snapshot --auto
+&git-dch; <option>--snapshot</option> <option>--auto</option>
 </screen>
    will fetch the commit id and add changelog entries from that point to the
    current HEAD - again auto incrementing the version number. If you don't want
    to start at that commit id, you can specify any id or tag with:</para>
 <screen>
-&git-dch; --since=e76a6a180a57701ae4ae381f74523cacb3152780 --snapshot
+&git-dch; <option>--since</option>=<replaceable>e76a6a180a57701ae4ae381f74523cacb3152780</replaceable> <option>--snapshot</option>
 </screen>
    <para>
    After testing you can remove the snapshot header by a final &git-dch; call:
    </para>
 <screen>
-&git-dch; --since=HEAD --release
+&git-dch; <option>--since</option>=<replaceable>HEAD</replaceable> <option>--release</option>
 </screen>
    <para>
    This will add no further entries but simply remove the specially crafted
@@ -60,18 +60,18 @@ git-buildpackage (0.3.7~1.gbp470ce2) UNRELEASED; urgency=low
    entries - or you can (of course) use <option>--auto</option> again.
    </para>
 <sect1 id="gbp.release.numbers">
-    <title>Special snapshot numbers</title>
+    <title>Customizing snapshot numbers</title>
     <para>If the auto incrementing of the snapshot number doesn't suite you needs you
     can give any python expression that evaluates to a positive integer to
     calculate the new snapshot number:</para>
 <screen>
-&git-dch; -S -a --snapshot-number=1
-&git-dch; -S -a --snapshot-number='snapshot + 2'
-&git-dch; -S -a --snapshot-number='os.popen("git-log --pretty=oneline | wc -l").readlines()[0]'
-&git-dch; -S -a --snapshot-number=`git-log --pretty=oneline debian/0.3.3 | wc -l`
+&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>1</replaceable>
+&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'snapshot + 2'</replaceable>
+&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'os.popen("git-log --pretty=oneline | wc -l").readlines()[0]'</replaceable>
+&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>`git-log --pretty=oneline debian/0.3.3 | wc -l`</replaceable>
 </screen>
 <para>
-You can also add the snapshot-number calculation to gbp.conf:
+You can also add the snapshot-number calculation to <filename>gbp.conf</filename>:
 </para>
 <programlisting>
 [DEFAULT]
-- 
cgit v1.2.3