summaryrefslogtreecommitdiffhomepage
path: root/docs/manpages/gbp-import-srpm.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/gbp-import-srpm.xml')
-rw-r--r--docs/manpages/gbp-import-srpm.xml262
1 files changed, 262 insertions, 0 deletions
diff --git a/docs/manpages/gbp-import-srpm.xml b/docs/manpages/gbp-import-srpm.xml
new file mode 100644
index 00000000..0055ed51
--- /dev/null
+++ b/docs/manpages/gbp-import-srpm.xml
@@ -0,0 +1,262 @@
+<refentry id="man.gbp.import.srpm">
+ <refentryinfo>
+ <address>
+ &rpm-email;
+ </address>
+ <author>
+ &rpm-firstname;
+ &rpm-surname;
+ </author>
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>gbp-import-srpm</refentrytitle>
+ &rpm-mansection;
+ </refmeta>
+ <refnamediv>
+ <refname>gbp-import-srpm</refname>
+ <refpurpose>Import source RPM packages into a Git repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &gbp-import-srpm;
+ &man.common.options.synopsis;
+ <arg><option>--vendor</option>=<replaceable>VENDOR</replaceable></arg>
+ <arg><option>--allow-same-versions</option></arg>
+ <arg><option>--author-is-committer</option></arg>
+ <arg><option>--packaging-branch=</option><replaceable>BRANCH-NAME</replaceable></arg>
+ <arg><option>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable></arg>
+ <arg><option>--packaging-dir=</option><replaceable>DIRECTORY</replaceable></arg>
+ <arg><option>--filter=</option><replaceable>PATTERN</replaceable></arg>
+ <arg><option>--keyid=</option><replaceable>GPG-KEYID</replaceable></arg>
+ <arg><option>--[no-]create-missing-branches</option></arg>
+ <arg><option>--[no-]pristine-tar</option></arg>
+ <arg><option>--[no-]sign-tags</option></arg>
+ <arg><option>--upstream-branch=</option><replaceable>BRANCH-NAME</replaceable></arg>
+ <arg><option>--upstream-tag=</option><replaceable>TAG-FORMAT</replaceable></arg>
+ <arg><option>--native</option></arg>
+ <arg><option>--repo-user=</option><option>[GIT|DEBIAN]</option></arg>
+ <arg><option>--repo-email=</option><option>[GIT|DEBIAN]</option></arg>
+ <group choice="plain">
+ <arg><replaceable>SRPM</replaceable></arg>
+ <arg><replaceable>DIRECTORY</replaceable></arg>
+ </group>
+ <arg choice="opt"><replaceable>target</replaceable></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ &gbp-import-srpm;
+ <arg><option>options</option></arg>
+ <group choice="plain">
+ <arg><replaceable>URL</replaceable></arg>
+ </group>
+ <arg choice="opt"><replaceable>target</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &gbp-import-srpm; imports an RPM source package into a &git; repository,
+ notes the package version in the commit logs, and commits the change. All
+ information, including package name, version and upstream source is
+ automatically detected from the source package but you can override the
+ location of the new repository by optionally specifying the
+ <replaceable>target</replaceable> argument. The tool supports importing
+ both archived (src.rpm files) or unpacked (directory) source RPMs. It also imports
+ from http(s)-URLs.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+ <variablelist>
+ &man.common.options.description;
+
+ <varlistentry>
+ <term><option>--vendor</option>=<replaceable>VENDOR</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Distribution vendor name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--upstream-branch</option>=<replaceable>BRANCH-NAME</replaceable>
+ </term>
+ <listitem>
+ <para>
+ The branch in the &git; repository the upstream sources are put
+ onto. Default is <replaceable>upstream</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--packaging-branch</option>=<replaceable>BRANCH-NAME</replaceable>
+ </term>
+ <listitem>
+ <para>
+ The branch in the &git; repository the packaging files are put
+ onto. Default is <replaceable>master</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--[no-]sign-tags</option>
+ </term>
+ <listitem>
+ <para>
+ GPG sign all created tags.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--keyid=</option><replaceable>GPG-KEYID</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Use this keyid for gpg signing tags.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Use this tag format when tagging released versions,
+ default is <replaceable>%(vendor)s/%(version)s</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--upstream-tag=</option><replaceable>TAG-FORMAT</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Use this tag format when tagging upstream versions,
+ default is <replaceable>upstream/%(version)s</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--git-packaging-dir=</option><replaceable>DIRECTORY</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Subdirectory where to put the RPM packaging files.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--filter=</option><replaceable>PATTERN</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Filter out files glob-matching pattern. Can be given multiple times.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--pristine-tar</option>
+ </term>
+ <listitem>
+ <para>
+ Generate pristine-tar delta file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--allow-same-version</option>
+ </term>
+ <listitem>
+ <para>
+ Allow one to re-import a package with an already existing version.
+ This will not re-import the upstream sources - only packaging files
+ will be re-imported.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--author-is-committer</option>
+ </term>
+ <listitem>
+ <para>
+ Use the author identity as the comitter when importing upstream
+ sources and packaging files.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--[no-]create-missing-branches</option>
+ </term>
+ <listitem>
+ <para>
+ Create missing upstream and/or packaging branch if missing.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--orphan-packaging</option>
+ </term>
+ <listitem>
+ <para>
+ Import packaging files into an orphan branch that will not be based
+ on the upstream branch. Useful if you want to maintain (non-native)
+ package using the 'orphan-packaging' model. This option have no
+ effect if <option>--native</option> is used.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--native</option>
+ </term>
+ <listitem>
+ <para>
+ Treat the package as native package. No separate upstream branch or
+ upstream tags will be created.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--repo-user=</option><option>[GIT|DEBIAN]</option></term>
+ <listitem>
+ <para>
+ When set to <option>DEBIAN</option>
+ use the <envar>DEBUSER</envar> environment variable to set the
+ user.name &git; configuration otherwise use &git;'s
+ defaults. Only affects newly created repos.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--repo-email=</option><option>[GIT|DEBIAN]</option></term>
+ <listitem>
+ <para>
+ When set to <option>DEBIAN</option>
+ use the <envar>DEBEMAIL</envar> environment variable to set the
+ user.email &git; configuration otherwise use &git;'s
+ defaults. Only affects newly created repos.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ &man.gbp.config-files;
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>
+ <xref linkend="man.gbp.buildpackage.rpm"/,
+ <xref linkend="man.gbp.pq.rpm"/,
+ <xref linkend="man.gbp.rpm.ch">,
+ <xref linkend="man.gbp.conf"/,
+ &man.seealso.common;
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+ <para>
+ &rpm-username; &rpm-email;
+ </para>
+ </refsect1>
+</refentry>