diff options
| author | Guido Günther <agx@sigxcpu.org> | 2012-03-08 08:57:20 +0100 |
|---|---|---|
| committer | Guido Günther <agx@sigxcpu.org> | 2012-03-08 13:56:21 +0100 |
| commit | 80cf6d42a52bec3972da4f8b2bc388673f4681d4 (patch) | |
| tree | d021a113e996b2507faeed5612b31bc3e5773b46 /docs/chapters | |
| parent | 45d7dc8811377f69d321e31a4d30fb534ab0155d (diff) | |
Add manual page for gbp.conf
Closes: #661748
Thanks: Jari Alto for the POD version
Diffstat (limited to 'docs/chapters')
| -rw-r--r-- | docs/chapters/cfgfile.sgml | 14 |
1 files changed, 11 insertions, 3 deletions
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 @@ </varlistentry> <varlistentry> <term>.gbp.conf</term> - <listitem><para>per repository/branch configuration</para></listitem> + <listitem><para>per repository/branch configuration (deprecated)</para></listitem> </varlistentry> <varlistentry> <term>debian/gbp.conf</term> @@ -23,7 +23,7 @@ <listitem><para>per (local) repository configuration</para></listitem> </varlistentry> </variablelist> - 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: <variablelist> <varlistentry> <term>[DEFAULT]</term> @@ -50,14 +50,20 @@ <listitem><para>Options in this section apply to &git-dch; only and override options from the [DEFAULT] section.</para></listitem> </varlistentry> + <varlistentry> + <term>...</term> + <listitem><para>Same for the other <command>git-*</command> and <command>gbp-*</command> commands</para></listitem> + </varlistentry> </variablelist> The actual options in these sections are the command line options without the '--' prefix. So <option>--upstream-branch=</option><replaceable>dfsgfree</replaceable> would read: <screen> <option>upstream-branch</option>=<replaceable>dfsgfree</replaceable> </screen> +<para> in the config file. In the special case of &git-buildpackage; the stripped prefix is not '--' but '--git-'. Here's a more complete example: +</para> <programlisting> [DEFAULT] # the default build command @@ -83,5 +89,7 @@ upstream-branch=notdfsgclean [git-dch] git-log=--no-merges </programlisting> - </para> +<para> +For more details see the <xref linkend="gbp.man.gbp.conf"> manual page. +</para> </chapter> |