summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGuido Guenther <agx@sigxcpu.org>2007-05-24 09:38:30 +0200
committerGuido Guenther <agx@bogon.sigxcpu.org>2007-05-24 09:38:30 +0200
commitb9cac7d9e1da408262ca6fd0461857cdd15f182b (patch)
treed8922c568e80e0a6d526223c4c190781c0c093d0
parentfe0594675ff802b7ec19e98704791b03e50ff824 (diff)
make the documented command line arguments match reality
-rw-r--r--docs/chapters/import.sgml17
-rw-r--r--docs/manpages/git-buildpackage.sgml4
-rw-r--r--docs/manpages/git-import-dsc.sgml4
-rw-r--r--docs/manpages/git-import-orig.sgml33
4 files changed, 38 insertions, 20 deletions
diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml
index 8ba17190..1420999f 100644
--- a/docs/chapters/import.sgml
+++ b/docs/chapters/import.sgml
@@ -17,16 +17,25 @@
<sect1 id="gbp.import.new.upstream">
<title>Importing a new upstream version</title>
<para>Change into your git repository, make sure it has all local
- modifications committed and do:
+ modifications committed and run either of:
<screen>
&git-import-orig; /path/to/package_0.2.orig.tar.gz
+&git-import-orig; /path/to/package_0.2.tar.bz2
+&git-import-orig; /path/to/package-0.2/
</screen>
- This puts the upstream souces onto the <emphasis>upsream</emphasis> branch
- using &git_load_dirs; to handle file removals and renames. The result of
+ This puts the upstream souces onto the <emphasis>upstream</emphasis> branch
+ using &gitloaddirs; to handle file removals and renames. The result of
this is then merged onto the <emphasis>master</emphasis> branch and a new
- changelog entry gets created. You can again specify different branch names
+ changelog entry is created. You can again specify different branch names
via the <option>--upstream-branch</option> and
<option>--debian-branch</option> options.
+ </para>
+ <para>
+ If you expect a merge conflict you can delay the merge to
+ <emphasis>master</emphasis> via the <option>--no-merge</option> and pull in
+ the changes from the <emphasis>upstream</emphasis> branch any time later.
+ </para>
+ <para>
</para>
</sect1>
<sect1 id="gbp.import.convert">
diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml
index 547f1e51..ae8eadf4 100644
--- a/docs/manpages/git-buildpackage.sgml
+++ b/docs/manpages/git-buildpackage.sgml
@@ -22,8 +22,8 @@
<arg><option>--git-ignore-new</option></arg>
<arg><option>--git-tag</option></arg>
<arg><option>--git-verbose</option></arg>
- <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
- <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
+ <arg><option>--git-upstream-branch=</option><replaceable>branch_name</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>
<arg><option>--git-sign-tags</option></arg>
diff --git a/docs/manpages/git-import-dsc.sgml b/docs/manpages/git-import-dsc.sgml
index 559e01aa..1af9d774 100644
--- a/docs/manpages/git-import-dsc.sgml
+++ b/docs/manpages/git-import-dsc.sgml
@@ -52,8 +52,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--verbose</option>, <option>-v</option>
- </term>
+ <term><option>--verbose</option></term>
+ <term><option>-v</option></term>
<listitem>
<para>verbose execution</para>
</listitem>
diff --git a/docs/manpages/git-import-orig.sgml b/docs/manpages/git-import-orig.sgml
index 4853e78a..a28047ec 100644
--- a/docs/manpages/git-import-orig.sgml
+++ b/docs/manpages/git-import-orig.sgml
@@ -22,6 +22,8 @@
&git-import-orig;
<arg><option>--verbose</option></arg>
+ <arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
+ <arg><option>--no-merge</option></arg>
<arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
<arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
<arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
@@ -34,15 +36,16 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-import-orig; imports the tar.gz archive given by
- <replaceable>upstream-source</replaceable> into the &git; repository. If
- <replaceable>upstream-source</replaceable> is already of the form
- <replaceable>package-name_version.orig.tar.gz</replaceable>, it reads the
- version information from the tarball's filename otherwise it can be
- specified on the commandline via <option>--upstream-version</option>.
+ &git-import-orig; imports <replaceable>upstream-source</replaceable> into
+ the &git; repository. <replaceable>upstream-source</replaceable> can either
+ be a gzip or bzip2 compressed tar archive or an alreay unpacked source
+ tree. If it is already of the form
+ <replaceable>package-name_version.orig.tar.gz</replaceable>, the version
+ information is read from the tarball's filename otherwise it can be
+ given on the command line via <option>--upstream-version</option>.
- When importing the new version <command>git_load_dirs</command> is being
- used to detect file renames and removals.
+ Upon import <command>git_load_dirs</command> is being used to detect file
+ renames and removals.
</para>
</refsect1>
<refsect1>
@@ -50,13 +53,19 @@
<variablelist>
<varlistentry>
- <term><option>--upstream-version</option>=<replaceable>version</replaceable>,
- <option>-u</option><replaceable>version</replaceable></term>
+ <term><option>--upstream-version</option>=<replaceable>version</replaceable></term>
+ <term><option>-u</option><replaceable>version</replaceable></term>
<listitem>
<para>The upstream version number</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--no-merge</option></term>
+ <listitem>
+ <para>Don't merge the upstream version to the development branch</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
</term>
<listitem>
@@ -75,8 +84,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--verbose</option>, <option>-v</option>
- </term>
+ <term><option>--verbose</option></term>
+ <term><option>-v</option></term>
<listitem>
<para>verbose execution</para>
</listitem>