diff options
author | Guido Günther <agx@sigxcpu.org> | 2018-05-21 13:26:30 +0200 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2018-05-21 13:26:30 +0200 |
commit | a1f4af5504373c1e1e65e98054a7f1040c21358a (patch) | |
tree | f33087ad24fa2d13e6c8dcb58fa297767af4df6d /docs | |
parent | 5f15b29224ab3b37ee0b7a422d7760fc4561f720 (diff) |
docs: document how to use GBP_CONF_FILES to override debian/gbp.conf
Closes: #898613
Diffstat (limited to 'docs')
-rw-r--r-- | docs/chapters/cfgfile.xml | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/chapters/cfgfile.xml b/docs/chapters/cfgfile.xml index 7fb3e699..16272a7b 100644 --- a/docs/chapters/cfgfile.xml +++ b/docs/chapters/cfgfile.xml @@ -94,4 +94,44 @@ <para> For more details, see the <xref linkend="man.gbp.conf"/> manual page. </para> + + <sect1 id="gbp.cfgfile.order"> + <title>Overriding Parsing Order</title> + <para> + The environment variable <envar>GBP_CONF_FILES</envar> can be + used to override the order in which configuration files are + parsed. The following example parses two configuration files in the + users home directory (<filename>~/.gbp.conf</filename> and + <filename>~/.gbp.late.conf</filename>) and in the debian + directory (<filename>debian/gbp.conf</filename>). + The file are parsed from left to right. Since <filename> + ~/.gbp.late.conf</filename> is at the very end of the list it + can be used to override configuration entries shipped by the + package. This can be useful if packages set + e.g. <option>export-dir</option> or + <option>tarball-dir</option> and you perfer different locations: + <programlisting> + $ cat <<EOF >~/.gbp.late.conf + [DEFAULT] + export-dir = ../build-area + tarball-dir = ../tarballs + EOF + + $ export GBP_CONF_FILES=~/.gbp.conf:debian/gbp.conf:~/.gbp.late.conf + $ cd <mypkg> + $ gbp config buildpackage.export-dir + ../build-area + </programlisting> + </para> + <para> + If you want all configuration files to be skipped, set + <envar>GBP_CONF_FILES</envar> to a non existing location. This way + only default values and options from the command line will be used: + <programlisting> + $ export GBP_CONFI_FILES=/does/not/exist + $ gbp config buildpackage.debian-branch + master + </programlisting> + </para> + </sect1> </chapter> |