Better document the default config file

1 files changed, 23 insertions, 14 deletions

diff --git a/gbp.conf b/gbp.conf
index 6024922b..1bc4bf9b 100644
--- a/gbp.conf
+++ b/gbp.conf
@@ -14,17 +14,17 @@
 #debian-tag = debian/%(version)s
 # use pristine-tar:
 #pristine-tar = True
-# Don't check if debian-branch == current branch
+# don't check if debian-branch == current branch:
 #ignore-branch = True
 
 # Options only affecting git-buildpackage
 [git-buildpackage]
 #upstream-branch = dfsgclean
-# uncomment this to automatically GPG sign tags
+# uncomment this to automatically GPG sign tags:
 #sign-tags = True
-# keyid to GPG sign tags with
+# keyid to GPG sign tags with:
 #keyid = 0xdeadbeef
-# push to a remote repository after a successful tag: 
+# push to a remote repository after a successful tag:
 #posttag = git-push git.example.com
 # call lintian after a successful build:
 #postbuild = lintian $GBP_CHANGES_FILE
@@ -35,39 +35,48 @@
 #tarball-dir = ../tarballs/
 #ignore-new = True
 #export = HEAD
-# Compress with bzip2
+# compress with bzip2
 #compression = bzip2
-# Use best compression
+# use best compression
 #compression-level = best
 
 # Options only affecting git-import-orig
 [git-import-orig]
+# set a different upstream branches to import to:
 #upstream-branch = newupstream
+# set a different branch to merge to:
 #debian-branch = dfsgclean
+# import filter:
 #filter = .svn
-# filter out files from tarball passed to pristine tar
+# filter out files from tarball passed to pristine tar:
 #filter-pristine-tar = True
 # hook run after the import:
 #postimport = git-dch -N%(version)s -S -a --debian-branch=$GBP_BRANCH
 # emulate old behaviour of calling dch:
 #postimport = dch -v%(version)s New Upstream Version
+# commit message:
+#import-msg = New upstream version %(version)s
 
 # Options only affecting git-import-dsc
 [git-import-dsc]
+# set a different upstream branch:
 #upstream-branch = svn-upstream
+# import filter:
 #filter = [ 'CVS', '.cvsignore' ]
 
 # Options only affecting git-dch
 [git-dch]
+# options passed to git-log:
 #git-log = --no-merges
+# next snapshot number:
 #snapshot-number = snapshot + 1
-# include 0 digits of the commit id in the changelog enty
-#id-length = 0
-# don't include information from meta tags
+# include 7 digits of the commit id in the changelog enty:
+#id-length = 7
+# don't include information from meta tags:
 #meta = False
-# what tags to look for to generate bug-closing changelog entries
+# what tags to look for to generate bug-closing changelog entries:
 #meta-closes = Closes|LP
-#full = False
-#Ignore Signed-off-by: lines:
+# include the full commit message in the changelog:
+#full = True
+# ignore Signed-off-by: lines:
 #ignore-regex=(Signed-off|Acked)-by:
-