aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/git-buildpackage.sgml
blob: 8ee48b0701e182b6f581b5341f666223be97b1b5 (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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<refentry id="gbp.man.git.buildpackage">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>git-buildpackage</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&git-buildpackage;</refname>
    <refpurpose>Build Debian packages from a Git repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &git-buildpackage;
      <arg><option>--git-ignore-new</option></arg>
      <arg><option>--git-tag</option></arg>
      <arg><option>--git-verbose</option></arg>
      <arg><option>--git-upstream-branch=</option><replaceable>treeish</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-[no-]sign-tags</option></arg>
      <arg><option>--git-keyid=</option><replaceable>gpg-keyid</replaceable></arg>
      <arg><option>--git-posttag=</option><replaceable>command</replaceable></arg>
      <arg><option>--git-debian-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg><option>--git-no-create-orig</option></arg>
      <arg><option>--git-tarball-dir=</option><replaceable>directory</replaceable></arg>
      <arg><option>--git-export-dir=</option><replaceable>directory</replaceable></arg>
      <arg><option>--git-export=</option><replaceable>treeish</replaceable></arg>
      <arg><option>--git-pristine-tar</option></arg>
      <arg><option>--git-dont-purge</option></arg>
      <arg><option>--git-tag-only</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
    &git-buildpackage; is used to build Debian source and .deb packages from a &git; repository.
    </para>
    <para>
        &git-buildpackage; will, in order:
   </para>
    <itemizedlist>
        <listitem><para>Verify that it is being executed from the
            proper location.</para>
        </listitem>
	<listitem><para>Verify that the repository doesn't contain any
	uncommitted source changes.</para>
	</listitem>
        <listitem><para>Verify that it is being executed from the
        correct branch.</para>
        </listitem>
	<listitem><para>
	(Optionally) export the source tree to a separate build area
	</para></listitem>
        <listitem><para>Build an orig.tar.gz if it doesn't exist.</para>
        </listitem>
        <listitem><para>Call <application>debuild</application>(1)
            (or the application specified via <option>--git-builder</option>)
            with arguments instructing it to ignore &git; meta-data in
            the diff.gz, passing along all arguments given to
            &git-buildpackage; that don't start with --git-.
          </para>
        </listitem>
	<listitem><para>
	(Optionally) tag the tree after a successful build
	</para></listitem>
	<listitem><para>
	(Optionally) call a post-tag hook - e.g. to push the results to a remote
	repository after creating the tag
	</para></listitem>
    </itemizedlist>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--git-ignore-new</option>
        </term>
        <listitem>
	  <para>Build the .diff.gz and debian package although there are
	  uncommitted changes in the source tree.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-tag</option>
        </term>
        <listitem>
          <para>Add a git tag after a successfull build.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></term>
        <listitem>
          <para>Use <replaceable>BUILD_CMD</replaceable> instead of <command>debuild -i\.git -I.git</command></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-cleaner=<replaceable>CLEAN_CMD</replaceable></option></term>
        <listitem>
          <para>Use <replaceable>CLEAN_CMD</replaceable> instead of <command>debuild clean</command></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-verbose</option>
        </term>
        <listitem>
          <para>verbose execution</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-upstream-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>Branch to build the orig.tar.gz from if no tag matching the
	  upstream version is found. Default is
	  <replaceable>upstream</replaceable>. You can give any treeish object
	  here.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>If you're not on this branch when invoking &git-buildpackage;
	  it will fail. Default is <replaceable>master</replaceable>. This is
	  done to make sure you don't accidentally release from a topic branch.
	  Not being on this branch will be ignored when using
	  <option>--git-ignore-new</option>.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-[no-]sign-tags</option>
        </term>
        <listitem>
	  <para>GPG sign all created tags</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-keyid=</option><replaceable>gpg-keyid</replaceable>
        </term>
        <listitem>
	  <para>use this keyid for gpg signing tags</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-posttag=</option><replaceable>command</replaceable>
        </term>
        <listitem>
	  <para>excecute <replaceable>command</replaceable> after tagging a new version</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-debian-tag=</option><replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>use this tag format when tagging Debian versions,
  	  default is <replaceable>debian/&lt;version&gt;</replaceable></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-no-create-orig</option>
        </term>
        <listitem>
	  <para>Don't try to create any orig.tar.gz</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-export-dir=</option><replaceable>directory</replaceable>
        </term>
        <listitem>
	  <para>Export the current branch head (or the treeish object given via
	  <option>--git-export</option> to <replaceable>directory</replaceable>
	  before building.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-export=</option><replaceable>treeish</replaceable>
        </term>
	<listitem> 
	  <para>Instead of exporting the current branch head, export the
	  treeish object <replaceable>treeish</replaceable>. The special name
	  <replaceable>INDEX</replaceable> exports the current index whereas
          the special name <replaceable>WC</replaceable> exports the current working
          copy as is.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-tarball-dir=</option><replaceable>directory</replaceable>
        </term>
        <listitem>
          <para>Search for original tarballs in <replaceable>directory</replaceable> instead of generating them</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-pristine-tar</option>
        </term>
        <listitem>
	  <para>use pristine-tar to create the orig.tar.gz</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-dont-purge</option>
        </term>
        <listitem>
	  <para>retain exported build directory after build</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-tag-only</option>
        </term>
        <listitem>
	  <para>don't build, only tag and run post-tag hooks</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
      &man.git.config-files;
      <para>All options in the config files are specified without the 'git-' prefix.</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>git-import-dsc</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>git-import-dscs</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>git-import-orig</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>