.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\"
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng .
.TH "GBP.CONF" "5" "01 June 2012" "" "gbp.conf Manual"
.SH NAME
gbp.conf \- git-buildpackage configuration file
.SH SYNOPSIS
.TP
\fB/etc/git-buildpackage/gbp.conf\fR
system wide
.TP
\fB~/.gbp.conf\fR
per user
.TP
\fB\&.gbp.conf\fR
per branch, can be published with the
repository (deprecated)
.TP
\fBdebian/gbp.conf\fR
per branch, can be published with the
repository
.TP
\fB\&.git/gbp.conf\fR
per repository
.SH "DESCRIPTION"
.PP
The \fIgbp.conf\fR provides default global options and specific options
for \fBgit-buildpackage\fR 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
(\fB#\fR). The generic file syntax is:
.nf
[DEFAULT]
# This is section for global settings. Affects all commands
key = value
[]
# Specific sections for each command, like \fBgit-buildpackage\fR
key = value
[remote-config ]
# Specific sections for a remote configuration. This can be used several
# times to set up remote configuration for gbp-create-remote-repo
key = value
.fi
.PP
\fBkey=value\fR pairs of the command sections reflect the command line
options and their settings. For example \fBgit-buildpackage\fR(1)
manualpage contains the \fB--git-export-dir\fR=\fIdiirectory\fR
option which can be turned into configuration file setting by dropping the
\fB--git\fR prefix with:
.nf
[git-buildpackage]
export-dir = directory
.fi
.PP
Notice that some option are actually repeatable, or take Python lists.
For example the \fBgit-import-orig\fR(1) commmand has the
\fB--filter\fR=\fIpattern\fR option which can
be truned into a configuration file option like this:
.nf
[git-import-orig]
filter = .svn
filter = .hg
.fi
.PP
An alternative way is to write it using Python list syntax:
.nf
[git-import-orig]
filter = [ '.svn', '.hg' ]
.fi
.PP
Boolean options can bei either \fBTrue\fR or \fBFalse\fR\&. For example
\fBgit-import-orig\fR(1); has the \fB--pristine-tar\fR and
\fB--no-pristine-tar\fR options which translate to:
.nf
[git-import-orig]
pristine-tar = True
.fi
.PP
and
.nf
[git-import-orig]
pristine-tar = False
.fi
.PP
respectively.
.sp
.RS
.B "Note:"
To see the current set of values that would be applied after parsing the
configuration files run the command with \fB--help\fR and check it's
output.
.RE
.sp
.RS
.B "Note:"
\fBgit-import-dscs\fR and \fBgit-pbuilder\fR
can't be configured via gbp.conf.
.RE
.PP
\fBgbp-create-remote-repo\fR(1) can additionally parse remote site
configurations from \fIgbp.conf\fR\&. For example a configration like:
.nf
[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
.fi
.PP
Can be used to create remote repositories for the pkg-libvirt project using:
.nf
gbp-create-remote-repo --remote-config=pkg-libvirt
.fi
.PP
This can be useful if you're often creating new remote repositores for
different projects.
.SH "EXAMPLES"
.PP
An example set up for packaging work:
.nf
# $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
.fi
.SH "ENVIRONMENT"
.TP
\fBGBP_CONF_FILES\fR
Colon separated list of files to parse. The default is
the above list of configuration files.
.SH "FILES"
.PP
See See \fI/etc/git-buildpackage/gbp.conf\fR for an example.
.SH "STANDARDS"
.PP
The at \fIThe Git-Buildpackage Manual\fR at
\fI/usr/share/doc/git-buildpackage/manual-html/index.html\fR
.SH "SEE ALSO"
.PP
\fBgbp-clone\fR(1),
\fBgbp-create-remote-repo\fR(1),
\fBgbp-pq\fR(1)
\fBgbp-pull\fR(1),
\fBgit-dch\fR(1),
\fBgit-import-dsc\fR(1),
\fBgit-import-orig\fR(1),
\fBgit-buildpackage\fR(1)
.SH "AUTHORS"
.PP
Guido Guenther
.PP
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.