gbp.conf5

Usage

Overview

The FCgbp.confF[0] configuration files provide default global options and specific options for individual gbp commands. All files have the same format as described below and are parsed in the above order from top to bottom with increasing precedence. Non existing files will be skipped.

Each file consists of either zero or one default section, and zero or one sections for each gbp command. Additionally, there can be an arbitrary number of FCremote-configF[0] sections. Comments start with a hash sign (FC#F[0]). The overall layout is:

FC
      [DEFAULT]
      # This section is for global settings. Affects all commands.
      # Options set here have the lowest priority.
      key = value
      [<command>]
      # Specific sections for each command, like buildpackage
      # Options set here have lower priority than command line options
      key = value
      [remote-config <name>]
      # Specific sections for a remote configuration. This can be used several
      # times to set up remote configuration for gbp create-remote-repo
      key = value
    F[0]

The sections for each command are named like the command (without gbp) surrounded by square brackets (e.g. FC[buildpackage]F[0]). For backwards compatibility, command sections starting with FCgit-F[0] or FCgbp-F[0] are also supported but will provoke a warning when parsed by gbp.

The keys in the FCkeyF[0]=FCvalueF[0] pairs are named like the command-line options of the corresponding command (with the '--' stripped off) and can hold the same values, but see below for details. In case of gbp buildpackage and gbp buildpackage-rpm the key needs '--git-' instead of '--' stripped off.

For example, the gbp-buildpackage(1) manual page documents the FC--git-export-dirF[0]=FCdirectoryF[0] option which can be turned into configuration file setting by dropping the FC--git-F[0] prefix:

FC
      [buildpackage]
      export-dir = directory
    F[0]

Options that can be repeated on the command line take Python-like lists in the config file. For example, the gbp-import-orig(1) command has the FC--filterF[0]=FCpatternF[0] option which can be turned into a configuration file option like this:

FC
      [import-orig]
      filter = [ '.svn', '.hg' ]
    F[0]

Boolean options can be either FCTrueF[0] or FCFalseF[0]. For example, gbp-import-orig(1) has the FC--pristine-tarF[0] and FC--no-pristine-tarF[0] options which translate to:

FC
      [import-orig]
      pristine-tar = True
    F[0]

and

FC
      [import-orig]
      pristine-tar = False
    F[0]

respectively.

FC
      [remote-config pkg-libvirt]
      # Location of the repository
      remote-url-pattern = ssh://git.debian.org/git/pkg-libvirt/%(pkg)s
      # Template dir to passed to git-init
      template-dir = /srv/alioth.debian.org/chroot/home/groups/pkg-libvirt/git-template
    F[0]

FC
      gbp-create-remote-repo --remote-config=pkg-libvirt
    F[0]

Examples

An example set up for packaging work:

FC
      # $HOME/.gbp.conf
      [DEFAULT]
      pristine-tar = True
      cleaner = fakeroot debian/rules clean
      [buildpackage]
      export-dir  = ../build-area/
      [import-orig]
      dch = False
        filter = [
        '.svn',
        '.hg',
        '.bzr',
        'CVS',
        'debian/*',
        '*/debian/*'
      ]
      filter-pristine-tar = True
      [import-dsc]
      filter = [
        'CVS',
        '.cvsignore',
        '.hg',
        '.hgignore'
        '.bzr',
        '.bzrignore',
        '.gitignore'
      ]
      # End of file
    F[0]

Environment

The following environment variables can be used to modify gbp's configuration file handling:

GBP_CONF_FILES

A colon separated list of configuration files to parse. If unset or empty the default list of files is parsed (see above).

GBP_DISABLE_SECTION_DEPRECATION

When set to a non-empty value don't print a deprecation warning in case gbp encounters a section starting with git- or gbp-.

GBP_DISABLE_GBP_CONF_DEPRECATION

When set to a non-empty value don't print a deprecation warning in case gbp encounters a configuration file in a deprecated location.

Files

See FC/etc/git-buildpackage/gbp.confF[0] for an example.