File: gbp-pristine-tar.xml

package info (click to toggle)
git-buildpackage 0.9.39
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,464 kB
  • sloc: python: 18,427; xml: 8,746; sh: 731; makefile: 139
file content (128 lines) | stat: -rw-r--r-- 4,546 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<refentry id="man.gbp.pristine.tar">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>gbp-pristine-tar</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>gbp-pristine-tar</refname>
    <refpurpose>Manage pristine-tar commits in a git repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-pristine-tar;

      &man.common.options.synopsis;
      <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg><option>--upstream-signatures=</option>[auto|on|off]</arg>
      <arg rep='repeat'><option>--component=</option><replaceable>component</replaceable></arg>
      <group choice="plain">
        <arg><option>commit</option></arg>
      </group>
      <group choice="plain">
        <arg choice="plain"><replaceable>filename</replaceable></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      &gbp-pristine-tar; adds the pristine-tar commit for a given upstream
      tarball to a &git; repository. This command is typically not invoked
      manually, as creating new pristine-tar commits is done automatically by
      e.g. &gbp-import-orig;. This command may howeer be useful if a original
      tarball has been already imported and the pristine-tar commits should be
      added at a later time or if you're tracking upstream git and want to
      create pristine-tar commits nevertheless.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      &man.common.options.description;
      <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>--upstream-signatures=</option>[auto|on|off]</term>
        <listitem>
          <para>
            Whether upstream signatures should be imported as well.
            <emphasis>off</emphasis> turns this off completely while
            <emphasis>on</emphasis> always tries to import a signature
            (which can be useful if you want to fail if e.g. &uscan;
            did not fetch a signature). The default
            <emphasis>auto</emphasis> means to import a signature file
            if present but do nothing otherwise.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--component=</option><replaceable>COMPONENT</replaceable>
        </term>
        <listitem>
          <para>
	    When creating the pristine-tar commits also look for an additional tarball
	    with component name <replaceable>COMPONENT</replaceable>. E.g. in
	    <filename>hello-debhelper_1.0.orig-foo.tar.gz</filename>
	    the component name would be <replaceable>foo</replaceable>. The additional
	    tarball is expected to be in the same directory than the upstream tarball
	    and to use the same compression type. This option can be
	    given multiple times to add multiple additional tarballs.
	  </para>
	  <para>
	    Using additional original tarballs is a feature of the 3.0
	    (quilt) source format. See
	    the <command>dpkg-source</command> manpage for
	    details. This is currently considered an experimental
	    feature and might change incompatibly.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    <para>Add pristine-tar commits for an upstream tarball:</para>
    <screen>
      &gbp-pristine-tar; commit ../upstream-tarball-0.1.tar.gz</screen>
    <para>Same as above with an additional
    tarball <filename>../upstream-tarball-foo-0.1.tar.gz:</filename></para>
    <screen>
      &gbp-pristine-tar; --component-tarball=foo commit ../upstream-tarball-0.1.tar.gz</screen>
</refsect1>
  <refsect1>
    &man.gbp.config-files;
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <xref linkend="man.gbp.import.orig"/>,
      <xref linkend="man.gbp.conf"/>,
      &man.seealso.common;
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>
    &dhusername; &dhemail;
    </para>
  </refsect1>
</refentry>
<!--  LocalWords:  xz lzma bzip gzip tarball
 -->