From 80cf6d42a52bec3972da4f8b2bc388673f4681d4 Mon Sep 17 00:00:00 2001 From: Guido Günther Date: Thu, 8 Mar 2012 08:57:20 +0100 Subject: Add manual page for gbp.conf Closes: #661748 Thanks: Jari Alto for the POD version --- docs/Makefile | 7 +- docs/chapters/cfgfile.sgml | 14 ++- docs/common.ent | 1 + docs/man.gbp.conf.sgml | 11 +++ docs/manpages/gbp.conf.sgml | 225 ++++++++++++++++++++++++++++++++++++++++++++ docs/manpages/manpages.ent | 1 + docs/manual.sgml | 1 + 7 files changed, 254 insertions(+), 6 deletions(-) create mode 100644 docs/man.gbp.conf.sgml create mode 100644 docs/manpages/gbp.conf.sgml diff --git a/docs/Makefile b/docs/Makefile index 8772f472..b10ec10f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,6 +1,6 @@ #!/usr/bin/make -COMMANDS = git-buildpackage \ +MANS = git-buildpackage \ git-import-dsc \ git-import-dscs \ git-import-orig \ @@ -8,10 +8,11 @@ COMMANDS = git-buildpackage \ gbp-pull \ gbp-clone \ gbp-pq \ - gbp-create-remote-repo + gbp-create-remote-repo \ + gbp.conf MANUAL=manual-html -SGML_MANPAGES=$(patsubst %,%.1,$(COMMANDS)) +SGML_MANPAGES=$(patsubst %,%.1,$(MANS)) POD_MANPAGES=git-pbuilder.1 MANPAGES=$(SGML_MANPAGES) $(POD_MANPAGES) VERSION_ENT=version.ent diff --git a/docs/chapters/cfgfile.sgml b/docs/chapters/cfgfile.sgml index d7c7a0da..fbff9e05 100644 --- a/docs/chapters/cfgfile.sgml +++ b/docs/chapters/cfgfile.sgml @@ -12,7 +12,7 @@ .gbp.conf - per repository/branch configuration + per repository/branch configuration (deprecated) debian/gbp.conf @@ -23,7 +23,7 @@ per (local) repository configuration - All have the same format. They consist of (at most) five sections, all of them are optional: + All have the same format. They consist of several sections, all of them are optional: [DEFAULT] @@ -50,14 +50,20 @@ Options in this section apply to &git-dch; only and override options from the [DEFAULT] section. + + ... + Same for the other git-* and gbp-* commands + The actual options in these sections are the command line options without the '--' prefix. So dfsgfree would read: =dfsgfree + in the config file. In the special case of &git-buildpackage; the stripped prefix is not '--' but '--git-'. Here's a more complete example: + [DEFAULT] # the default build command @@ -83,5 +89,7 @@ upstream-branch=notdfsgclean [git-dch] git-log=--no-merges - + +For more details see the manual page. + diff --git a/docs/common.ent b/docs/common.ent index 735511ae..9c1b2894 100644 --- a/docs/common.ent +++ b/docs/common.ent @@ -17,6 +17,7 @@ pbuilder"> pdebuild"> debuild"> + gbp.conf"> Debian"> Git"> diff --git a/docs/man.gbp.conf.sgml b/docs/man.gbp.conf.sgml new file mode 100644 index 00000000..c01433fe --- /dev/null +++ b/docs/man.gbp.conf.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +gbp.conf Manual +&man.gbp.conf; + diff --git a/docs/manpages/gbp.conf.sgml b/docs/manpages/gbp.conf.sgml new file mode 100644 index 00000000..d3f7d6ad --- /dev/null +++ b/docs/manpages/gbp.conf.sgml @@ -0,0 +1,225 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp.conf + &dhsection; + + + &gbp.conf; + git-buildpackage configuration file + + + + + /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 + + + + + pairs of the command sections reflect the command line +options and their settings. For example +manualpage contains the =diirectory +option which can be turned into configuration file setting by dropping the + prefix with: + + + [git-buildpackage] + export-dir = directory + + + +Notice that some option are actually repeatable, or take Python lists. +For example the commmand has the +=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 or . For example +; has the and + options which translate to: + + + [git-import-orig] + pristine-tar = True + + +and + + + [git-import-orig] + pristine-tar = False + +respectively. + + + + 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 + + + + 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-dscs + 1 + , + + git-import-orig + 1 + , + + git-pbuilder + 1 + , + + git-buildpackage + 1 + , + + + + AUTHORS + &dhusername; &dhemail; + This manual page is based on a POD version by Jari Aalto jari.aalto@cante.net. + Released under license GNU GPL version 2 or (at your option) any later. + version. + + + diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent index be577db8..058b66d4 100644 --- a/docs/manpages/manpages.ent +++ b/docs/manpages/manpages.ent @@ -7,5 +7,6 @@ + diff --git a/docs/manual.sgml b/docs/manual.sgml index 3e3add82..4b9026fa 100644 --- a/docs/manual.sgml +++ b/docs/manual.sgml @@ -36,6 +36,7 @@ &man.gbp.pull; &man.gbp.pq; &man.gbp.create.remote.repo; + &man.gbp.conf; Copyright -- cgit v1.2.3