gbp.conf

Name

gbp.conf -- git-buildpackage configuration file

Synopsis

/etc/git-buildpackage/gbp.conf

system wide

~/.gbp.conf

per user

.gbp.conf

per branch, can be published with the repository (deprecated)

debian/gbp.conf

per branch, can be published with the repository

.git/gbp.conf

per repository

DESCRIPTION

The gbp.conf 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 (#). The generic file syntax is:

    [DEFAULT]
    # This is section for global settings. Affects all commands
    key = value

    [<command>]
    # Specific sections for each command, like git-buildpackage
    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

key=value pairs of the command sections reflect the command line options and their settings. For example git-buildpackage(1) manualpage contains the --git-export-dir=diirectory option which can be turned into configuration file setting by dropping the --git prefix with:

    [git-buildpackage]
    export-dir = directory

Notice that some option are actually repeatable, or take Python lists. For example the git-import-orig(1) commmand has the --filter=pattern option which can be truned into a configuration file option like this:

    [git-import-orig]
    filter = .svn
    filter = .hg

An alternative way is to write it using Python list syntax:

    [git-import-orig]
    filter = [ '.svn', '.hg' ]

Boolean options can bei either True or False. For example git-import-orig(1); has the --pristine-tar and --no-pristine-tar options which translate to:

    [git-import-orig]
    pristine-tar = True

and

    [git-import-orig]
    pristine-tar = False

respectively.

Note: To see the current set of values that would be applied after parsing the configuration files run the command with --help and check it's output.

Note: git-import-dscs and git-pbuilder can't be configured via gbp.conf.

gbp-create-remote-repo(1) can additionally parse remote site configurations from gbp.conf. For example a configration like:

[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

Can be used to create remote repositories for the pkg-libvirt project using:

gbp-create-remote-repo --remote-config=pkg-libvirt

This can be useful if you're often creating new remote repositores for different projects.

EXAMPLES

An example set up for packaging work:

 # $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

ENVIRONMENT

GBP_CONF_FILES

Colon separated list of files to parse. The default is the above list of configuration files.

FILES

See See /etc/git-buildpackage/gbp.conf for an example.

STANDARDS

The at The Git-Buildpackage Manual at /usr/share/doc/git-buildpackage/manual-html/index.html

SEE ALSO

gbp-clone(1), gbp-create-remote-repo(1), gbp-pq(1) gbp-pull(1), git-dch(1), git-import-dsc(1), git-import-orig(1), git-buildpackage(1)

AUTHORS

Guido Guenther

This manual page is based on a POD version by Jari Aalto . Released under license GNU GPL version 2 or (at your option) any later. version.