aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2016-12-26 20:15:17 +0100
committerGuido Günther <agx@sigxcpu.org>2016-12-26 20:15:17 +0100
commitd90e6be44fd6678830a0766b7e545cbb9c13ed1e (patch)
treead2a4f8c6c4131c589e1795f7b2af744931d08a4 /docs
parentbad1f2370ba311bbe5981b204d4fa244b1d9a514 (diff)
import-orig: determine download automatically
Diffstat (limited to 'docs')
-rw-r--r--docs/common.ent1
-rw-r--r--docs/manpages/gbp-import-orig.sgml71
2 files changed, 50 insertions, 22 deletions
diff --git a/docs/common.ent b/docs/common.ent
index 0d118074..45cbce08 100644
--- a/docs/common.ent
+++ b/docs/common.ent
@@ -37,6 +37,7 @@
<!ENTITY rpmbuild "<command>rpmbuild</command>">
<!ENTITY gbp-builder-mock "<command>gbp-builder-mock</command>">
<!ENTITY wget "<command>wget</command>">
+ <!ENTITY uscan "<command>uscan</command>">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY git "<productname>Git</productname>">
diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml
index 1e86a94d..b8cd51c9 100644
--- a/docs/manpages/gbp-import-orig.sgml
+++ b/docs/manpages/gbp-import-orig.sgml
@@ -38,9 +38,9 @@
<arg><option>--postimport=cmd</option></arg>
<arg><option>--[no-]interactive</option></arg>
<arg><option>--[no-]rollback</option></arg>
- <arg><option>--download</option></arg>
<group choice="plain">
- <arg choice="plain"><replaceable>upstream-source</replaceable></arg>
+ <arg choice="plain"><replaceable>filename</replaceable></arg>
+ <arg choice="plain"><replaceable>url</replaceable></arg>
<arg><option>--uscan</option></arg>
</group>
</cmdsynopsis>
@@ -48,15 +48,41 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &gbp-import-orig; imports <replaceable>upstream-source</replaceable> into
- the &git; repository. <replaceable>upstream-source</replaceable> can either
- be a gzip, bzip2, lzma or xz compressed tar archive, a zip archive, or an
- already 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>. If the source
- package name or version can't be determined, &gbp-import-orig; will prompt
- for it unless <option>--no-interactive</option> is given.
+ &gbp-import-orig; imports upstream sources into a &git;
+ repository. It can import from three sources:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <replaceable>filename</replaceable>: A file in the local
+ file system. Gzip, bzip2, lzma and xz compressed tar
+ archives, zip archives and already unpacked source trees are
+ supported.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <replaceable>url</replaceable>: The tarball is downloaded
+ from a <replaceable>http</replaceable>
+ or <replaceable>https</replaceable> <replaceable>url</replaceable>.
+ This needs the python-request package installed.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>--uscan</option>: The latest upstream version is fetched
+ via &uscan; relying on <filename>debian/watch</filename>.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ If the tarballs name is already of the form
+ <replaceable>package-name_version.orig.tar.gz</replaceable>, the
+ version information is determined from the tarball's filename,
+ otherwise it can be given on the command line
+ via <option>--upstream-version</option>. If the source package
+ name or version can't be determined, &gbp-import-orig; will
+ prompt for it unless <option>--no-interactive</option> is given.
</para>
<para>
The sources are placed on the upstream branch (default:
@@ -302,16 +328,7 @@
<term><option>--uscan</option></term>
<listitem>
<para>
- Use uscan to fetch new upstream version.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--uscan</option></term>
- <listitem>
- <para>
- Download the tarball from the given HTTP URL. This needs
- python-request installed.
+ Use &uscan; to fetch new upstream version.
</para>
</listitem>
</varlistentry>
@@ -343,7 +360,13 @@
&gbp-import-orig; --uscan
</screen>
<para>
- After downloading an upstream tarball by hand, import it
+ Fetch tarball from an URL
+ </para>
+ <screen>
+ &gbp-import-orig; https://debian.example.com/sid/upstream-tarball-0.1.tar.gz
+ </screen>
+ <para>
+ Import a local tarball
</para>
<screen>
&gbp-import-orig; ../upstream-tarball-0.1.tar.gz
@@ -360,6 +383,10 @@
<xref linkend="man.gbp.import.dscs"/>,
<xref linkend="man.gbp.dch"/>,
<xref linkend="man.gbp.conf"/>,
+ <citerefentry>
+ <refentrytitle>uscan</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
&man.seealso.common;
</para>
</refsect1>