aboutsummaryrefslogtreecommitdiff
path: root/docs/chapters/cfgfile.sgml
blob: fbff9e05aa302ea295996f1c884d32713f8e427d (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
<chapter id="gbp.cfgfile">
    <title>Configuration files</title>
    <para>The configuration files are parsed in this order:
    <variablelist>
      <varlistentry>
      <term>/etc/git-buildpackage/gbp.conf</term>
      <listitem><para>system wide configuraton</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>~/.gbp.conf</term>
      <listitem><para>per user configuration</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>.gbp.conf</term>
      <listitem><para>per repository/branch configuration (deprecated)</para></listitem> 
      </varlistentry> 
      <varlistentry>
      <term>debian/gbp.conf</term>
      <listitem><para>per repository/branch configuration</para></listitem> 
      </varlistentry> 
      <varlistentry>
      <term>.git/gbp.conf</term>
      <listitem><para>per (local) repository configuration</para></listitem> 
      </varlistentry> 
    </variablelist>
    All have the same format. They consist of several sections, all of them are optional:
    <variablelist>
      <varlistentry>
      <term>[DEFAULT]</term>
      <listitem><para>Options in this section apply to &git-buildpackage;,
      &git-import-orig;, &git-import-dsc; and &git-dch;.</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>[git-buildpackage]</term>
      <listitem><para>Options in this section apply to &git-buildpackage; only and override options from the
      [DEFAULT] section.</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>[git-import-orig]</term>
      <listitem><para>Options in this section apply to &git-import-orig; only and override options from the
      [DEFAULT] section.</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>[git-import-dsc]</term>
      <listitem><para>Options in this section apply to &git-import-dsc; only and override options from the
      [DEFAULT] section.</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>[git-dch]</term>
      <listitem><para>Options in this section apply to &git-dch; only and override options from the
      [DEFAULT] section.</para></listitem>
      </varlistentry>
      <varlistentry>
      <term>...</term>
      <listitem><para>Same for the other <command>git-*</command> and <command>gbp-*</command> commands</para></listitem>
      </varlistentry>
    </variablelist>
    The actual options in these sections are the command line options without
    the '--' prefix. So <option>--upstream-branch=</option><replaceable>dfsgfree</replaceable> would read:
<screen>
<option>upstream-branch</option>=<replaceable>dfsgfree</replaceable>
</screen>
<para>
    in the config file. In the special case of &git-buildpackage; the stripped
    prefix is not '--' but '--git-'. Here's a more complete example:
</para>
<programlisting>
[DEFAULT]
# the default build command
builder=debuild -i\.git -I.git
# the default branch for upstream sources
upstream-branch=upstream
# the default branch for the debian patch
debian-branch=master

[git-buildpackage]
upstream-branch=dfsgclean
# Sign tags with GPG:
sign-tags = True
# Keyid to sign tags with
#keyid = 0xdeadbeef

[git-import-orig]
upstream-branch=notdfsgclean

[git-import-dsc]
upstream-branch=notdfsgclean

[git-dch]
git-log=--no-merges
</programlisting>
<para>
For more details see the <xref linkend="gbp.man.gbp.conf"> manual page.
</para>
</chapter>