aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/gbp.conf.sgml
blob: e0330d73e3e1066c7a70d36ea0510cbfc56e82a2 (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
<refentry id="gbp.man.gbp.conf">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
   <refentrytitle>gbp.conf</refentrytitle>
    &dhconfsection;
  </refmeta>
  <refnamediv>
    <refname>&gbp.conf;</refname>
    <refpurpose>git-buildpackage configuration file</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
   <variablelist>
      <varlistentry>
      <term>/etc/git-buildpackage/gbp.conf</term>
      <listitem><para>system wide</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>~/.gbp.conf</term>
      <listitem><para>per user</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>.gbp.conf</term>
      <listitem><para>per branch, can be published with the
      repository (deprecated)</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>debian/gbp.conf</term>
      <listitem><para>per branch, can be published with the
      repository</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>.git/gbp.conf</term>
      <listitem><para>per repository</para></listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <filename>gbp.conf</filename> provides default global options and specific options
      for &git-buildpackage; commands. All have the same format and are parsed in the above order. The
      file consists of several sections, one for each command. Comments start with a hash sign
      (<option>#</option>). The generic file syntax is:
    </para>
<programlisting>
    [DEFAULT]
    # This is section for global settings. Affects all commands
    key = value

    [&lt;command&gt;]
    # Specific sections for each command, like &git-buildpackage;
    key = value
</programlisting>

<para>

<option>key=value</option> pairs of the command sections reflect the command line
options and their settings. For example <xref linkend="gbp.man.git.buildpackage">
manualpage contains the <option>--git-export-dir</option>=<parameter>diirectory</parameter>
option which can be turned into configuration file setting by dropping the
<option>--git</option> prefix with:

<programlisting>
    [git-buildpackage]
    export-dir = directory
</programlisting>

<para>
Notice that some option are actually repeatable, or take Python lists.
For example the <xref linkend="gbp.man.git.import.orig"> commmand has the
<option>--filter</option>=<parameter>pattern</parameter> option which can
be truned into a configuration file option like this:

<programlisting>
    [git-import-orig]
    filter = .svn
    filter = .hg
</programlisting>

<para>
An alternative way is to write it using Python list syntax:
</para>

<programlisting>
    [git-import-orig]
    filter = [ '.svn', '.hg' ]
</programlisting>

<para>
Boolean options can bei either <option>True</option> or <option>False</option>. For example
<xref linkend="gbp.man.git.import.orig">; has the <option>--pristine-tar</option> and
<option>--no-pristine-tar</option> options which translate to:
</para>
<programlisting>
    [git-import-orig]
    pristine-tar = True
</programlisting>

<para>and</para>

<programlisting>
    [git-import-orig]
    pristine-tar = False
</programlisting>
<para>respectively.</para>
<note>
<para>
To see the current set of values that would be applied after parsing the
configuration files run the command with <option>--help</option> and check it's
output.
</para>
</note>
<note>
<para>
 <command>git-import-dscs</command> and <command>git-pbuilder</command>
can't be configured via gbp.conf.
</para>
</note>

  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
<para>
An example set up for packaging work:
</para>

<programlisting>
 # $HOME/gbp.conf

 [DEFAULT]
 pristine-tar = True
 cleaner = fakeroot debian/rules clean

 [git-buildpackage]
 export-dir  = ../build-area/

 [git-import-orig]
 dch = False
 filter = .svn
 filter = .hg
 filter = .bzr
 filter = CVS
 filter = debian/*
 filter = */debian/*
 filter-pristine-tar = True

 [git-import-dsc]
 filter = [
        'CVS',
        '.cvsignore',
        '.hg',
        '.hgignore'
        '.bzr',
        '.bzrignore',
        '.gitignore'
        ]

 # End of file
</programlisting>

<refsect1>
  <title>ENVIRONMENT</title>
   <variablelist>
      <varlistentry>
      <term>GBP_CONF_FILES</term>
      <listitem><para>Colon separated list of files to parse. The default is
the above list of configuration files.</para></listitem>
      </varlistentry>
   </variablelist>
</refsect1>

<refsect1>
  <title>FILES</title>
<para>
  See See <filename>/etc/git-buildpackage/gbp.conf</filename> for an example.
</para>
</refsect1>

<refsect1>
  <title>STANDARDS</title>
<para>
  The at <ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html">
    <citetitle>The Git-Buildpackage Manual</citetitle></ulink> at
  <filename>/usr/share/doc/git-buildpackage/manual-html/index.html</filename>
</para>
</refsect1>

<refsect1>
  <title>SEE ALSO</title>
  <para>
    <citerefentry>
      <refentrytitle>gbp-clone</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>gbp-create-remote-repo</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>gbp-pq</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>
    <citerefentry>
      <refentrytitle>gbp-pull</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>git-dch</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>git-import-dsc</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>git-import-orig</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>git-buildpackage</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>
  </para>
</refsect1>
<refsect1>
  <title>AUTHORS</title>
  <para>&dhusername; &dhemail;</para>
  <para>This manual page is based on a POD version by Jari Aalto <email>jari.aalto@cante.net</email>.
	Released under license GNU GPL version 2 or (at your option) any later.
    version.
  </para>
  </refsect1>
</refentry>