From 9bbbc77feb411cc6c72c0bf6df5b0c22e31729e6 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Date: Fri, 29 Jul 2011 13:58:54 +0200
Subject: [PATCH] Better document --git-upstream-tree

---
 docs/chapters/building.sgml         | 8 +++-----
 docs/manpages/git-buildpackage.sgml | 4 ++--
 gbp.conf                            | 3 ++-
 3 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/docs/chapters/building.sgml b/docs/chapters/building.sgml
index d6c11f0..911a1dd 100644
--- a/docs/chapters/building.sgml
+++ b/docs/chapters/building.sgml
@@ -12,11 +12,9 @@
 <screen>
 &git-buildpackage; <option>--git-ignore-new</option>
 </screen>
-    <para>If &git-buildpackage; doesn't find a valid upstream tarball it will create
-    one by looking at the tag matching the upstream version, if no tag can be
-    found it uses the tip of the current <option>upstream-branch</option>. Any
-    other treeish object to create the upstream tarball from can be given with
-    the <option>--upstream-branch</option> option.
+    <para>If &git-buildpackage; doesn't find a valid upstream tarball it will
+    create one by looking at the tag matching the upstream version. To change
+    this behaviour see the <option>--git-upstream-tree</option> option.
     </para><para>
     If you want to recreate the original tarball using the additional
     information from the <option>pristine-tar branch</option> you have to
diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml
index f79ad6a..77b7ab1 100644
--- a/docs/manpages/git-buildpackage.sgml
+++ b/docs/manpages/git-buildpackage.sgml
@@ -185,8 +185,8 @@
         <term><option>--git-upstream-branch</option>=<replaceable>branch_name</replaceable>
         </term>
         <listitem>
-	  <para>Branch to build the orig tarball from if no tag matching the
-	  upstream version is found. Default is
+	  <para>Branch to build the orig tarball from if <option>--git-upstream-tree</option>
+	  is set to <replaceable>branch</replaceable>. Default is
 	  <replaceable>upstream</replaceable>. You can give any treeish object
 	  here.</para>
         </listitem>
diff --git a/gbp.conf b/gbp.conf
index 22ac648..cb0926f 100644
--- a/gbp.conf
+++ b/gbp.conf
@@ -21,7 +21,8 @@
 
 # Options only affecting git-buildpackage
 [git-buildpackage]
-#upstream-branch = dfsgclean
+# Look for a tag matching the upstream version when creating a tarball
+#upstream-tree = tag
 # uncomment this to automatically GPG sign tags:
 #sign-tags = True
 # keyid to GPG sign tags with:
-- 
2.7.4