aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/git-import-orig.sgml
blob: 9d23ab52312811ac516fcf1ccaf735deebcfd4e3 (plain)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<refentry id="gbp.man.git.import.orig">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
   <refentrytitle>git-import-orig</refentrytitle> 
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&git-import-orig;</refname>

    <refpurpose>Import an upstream source into a git repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &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>--no-dch</option></arg>
      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--[no-]sign-tags</option></arg>
      <arg><option>--keyid=</option><replaceable>gpg-keyid</replaceable></arg>
      <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg><option>--filter=</option><replaceable>pattern</replaceable></arg>
      <arg><option>--pristine-tar</option></arg>
      <arg choice="plain"><replaceable>upstream-source</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
    &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 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>.
    </para>
     
    <para>The sources are placed on the upstream branch (default:
    <replaceable>upstream</replaceable>), tagged and merged onto the debian
    branch (default: <replaceable>master</replaceable>).
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <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>--no-dch</option></term>
        <listitem>
	  <para>don't call dch after the import</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>--debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>The branch in the Git repository the Debian package is being
	  developed on, default is <replaceable>master</replaceable>. After
	  importing the new sources on the upstream branch, &git-import-orig;
	  will try to merge the new version onto this branch.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--verbose</option></term> 
	<term><option>-v</option></term>
        <listitem>
          <para>verbose execution</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>--upstream-tag=</option><replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>use this tag format when tagging upstream versions,
	  default is <replaceable>upstream/&lt;version&gt;</replaceable></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>
    </variablelist>
  </refsect1>
  <refsect1>
      &man.git.config-files;
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>
      <citerefentry>
        <refentrytitle>git-buildpackage</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>git-import-dsc</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>git-import-dscs</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>git-dch</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      &man.seealso.common;
    </para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhusername; &dhemail;</para>

  </refsect1>
</refentry>