From e8aad12d766b606ce96fa4f3b5b744056b7b3e68 Mon Sep 17 00:00:00 2001
From: Guido Guenther <agx@sigxcpu.org>
Date: Wed, 17 Oct 2007 00:08:22 +0200
Subject: document the new git-buildpackage options

---
 docs/chapters/special.sgml          |  1 -
 docs/manpages/git-buildpackage.sgml | 33 +++++++++++++++++++++++++++++++--
 gbp.conf                            |  2 ++
 3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/docs/chapters/special.sgml b/docs/chapters/special.sgml
index 6c2207f..fcf46c2 100644
--- a/docs/chapters/special.sgml
+++ b/docs/chapters/special.sgml
@@ -58,7 +58,6 @@ cleanup-script.sh
     the <emphasis>upstream</emphasis> branch but merge the changes to the
     <emphasis>master</emphasis> branch as usual.
     </para>
-    </note>
     </sect1>
 
     <sect1 id="gbp.special.pbuilder">
diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml
index e1803ca..473ca1e 100644
--- a/docs/manpages/git-buildpackage.sgml
+++ b/docs/manpages/git-buildpackage.sgml
@@ -22,7 +22,7 @@
       <arg><option>--git-ignore-new</option></arg>
       <arg><option>--git-tag</option></arg>
       <arg><option>--git-verbose</option></arg>
-      <arg><option>--git-upstream-branch=</option><replaceable>branch_name</replaceable></arg>
+      <arg><option>--git-upstream-branch=</option><replaceable>treeish</replaceable></arg>
       <arg><option>--git-debian-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--git-builder=</option><replaceable>BUILD_CMD</replaceable></arg>
       <arg><option>--git-cleaner=</option><replaceable>CLEAN_CMD</replaceable></arg>
@@ -31,6 +31,8 @@
       <arg><option>--git-posttag=</option><replaceable>command</replaceable></arg>
       <arg><option>--git-debian-tag=</option><replaceable>tag-format</replaceable></arg>
       <arg><option>--git-no-create-orig</option></arg>
+      <arg><option>--git-export-dir=</option><replaceable>directory</replaceable></arg>
+      <arg><option>--git-export=</option><replaceable>treeish</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
@@ -51,6 +53,9 @@
         <listitem><para>Verify that it is being executed from the
         correct branch.</para>
         </listitem>
+	<listitem><para>
+	(Optionally) export the source tree to a separate build area
+	</para></listitem>
         <listitem><para>Build an orig.tar.gz if it doesn't exist.</para>
         </listitem>
         <listitem><para>Call <application>debuild</application>(1)
@@ -60,6 +65,13 @@
             &git-buildpackage; that don't start with --git-.
           </para>
         </listitem>
+	<listitem><para>
+	(Optionally) tag the tree after a successful build
+	</para></listitem>
+	<listitem><para>
+	(Optionally) call a post-tag hook - e.g. to push the results to a remote
+	repository after creating the tag
+	</para></listitem>
     </itemizedlist>
   </refsect1>
   <refsect1>
@@ -104,7 +116,10 @@
         <term><option>--git-upstream-branch</option>=<replaceable>branch_name</replaceable>
         </term>
         <listitem>
-	  <para>Branch to build the orig.tar.gz from. Default is <replaceable>upstream</replaceable></para>
+	  <para>Branch to build the orig.tar.gz from if no tag matching the
+	  upstream version is found. Default is
+	  <replaceable>upstream</replaceable>. You can give any treeish object
+	  here.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -154,6 +169,20 @@
 	  <para>Don't try to create any orig.tar.gz</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--git-export-dir=</option><replaceable>directory</replaceable>
+        </term>
+        <listitem>
+          <para>Export the current branch head to <replaceable>directory</replaceable> before building.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--git-export=</option><replaceable>treeish</replaceable>
+        </term>
+	<listitem> <para>Instead of exporting the current branch head export at
+	the treeish object <replaceable>treeish</replaceable>.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
diff --git a/gbp.conf b/gbp.conf
index 15ecef3..57b4b44 100644
--- a/gbp.conf
+++ b/gbp.conf
@@ -22,6 +22,8 @@
 #keyid = 0xdeadbeef
 # push to a remote repository after a successful tag: 
 #posttag = git-push git.example.com
+# use this for more svn-buildpackage like bahaviour:
+#export-dir = ../build-area/
 
 # Options only affecting git-import-orig
 [git-import-orig]
-- 
cgit v1.2.3