diff options
author | Guido Günther <agx@sigxcpu.org> | 2017-10-06 12:01:32 +0200 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2017-10-06 12:06:03 +0200 |
commit | f6e360f6ca0b4e3b510f82546a1daada592b18b6 (patch) | |
tree | 3c2b5b7f6faf55c5832a548d1d0939bcc871b746 /docs | |
parent | 827aeac266ad080343deaacc063deea611b4241d (diff) |
manpages: reindent for better layout
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile | 3 | ||||
-rw-r--r-- | docs/manpages/gbp.conf.xml | 317 |
2 files changed, 161 insertions, 159 deletions
diff --git a/docs/Makefile b/docs/Makefile index ae8be4cd..e6e94c2c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -49,6 +49,9 @@ $(MANUAL)/index.html: manual.xml chapters/*.xml manpages/*.xml common.ent $(VERS /usr/share/gtk-doc/data/*.css \ $(MANUAL) +$(MANUAL)/gbp.pdf: manual.xml chapters/*.xml manpages/*.xml common.ent $(VERSION_ENT) + xsltproc -o $(MANUAL)/ /usr/share/gtk-doc/data/gtk-doc.xsl $< + css: $(MANUAL)/gbp.css $(MANUAL)/gbp.svg $(MANUAL)/gbp.css $(MANUAL)/gbp.svg: gbp.css gbp.svg cp gbp.css gbp.svg $(MANUAL)/ diff --git a/docs/manpages/gbp.conf.xml b/docs/manpages/gbp.conf.xml index 322340d7..0e5dd978 100644 --- a/docs/manpages/gbp.conf.xml +++ b/docs/manpages/gbp.conf.xml @@ -58,152 +58,151 @@ <option>remote-config</option> sections. Comments start with a hash sign (<option>#</option>). The overall layout is: </para> -<programlisting> - [DEFAULT] - # This section is for global settings. Affects all commands. - # Options set here have the lowest priority. - key = value + <programlisting> + # This section is for global settings. Affects all commands. + # Options set here have the lowest priority. + key = value - [<command>] - # Specific sections for each command, like <command>buildpackage</command> - # Options set here have lower priority than command line options - key = value - [remote-config <name>] - # Specific sections for a remote configuration. This can be used several - # times to set up remote configuration for <command>gbp create-remote-repo</command> - key = value -</programlisting> -<para> - The sections for each command are named like the command (without &gbp;) surrounded - by square brackets (e.g. <option>[buildpackage]</option>). - For backwards compatibility, command sections starting with <filename>git-</filename> or - <filename>gbp-</filename> are also supported but will provoke a warning when parsed by - &gbp;. -</para> + # Specific sections for each command, like <command>buildpackage</command> + # Options set here have lower priority than command line options + key = value -<para> - The keys in the - <option>key</option>=<parameter>value</parameter> pairs are named - like the command-line options of the corresponding command (with the - '--' stripped off) and can hold the same values, but see below for - details. In case of &gbp-buildpackage; and &gbp-buildpackage-rpm; - the key needs '--git-' instead of '--' stripped off. -</para> -<para> - For example, - the <xref linkend="man.gbp.buildpackage"/> manual page documents - the <option>--git-export-dir</option>=<parameter>directory</parameter> - option which can be turned into configuration file setting by - dropping the - <option>--git-</option> prefix: -</para> + [remote-config <name>] + # Specific sections for a remote configuration. This can be used several + # times to set up remote configuration for <command>gbp create-remote-repo</command> + key = value + </programlisting> + <para> + The sections for each command are named like the command (without &gbp;) surrounded + by square brackets (e.g. <option>[buildpackage]</option>). + For backwards compatibility, command sections starting with <filename>git-</filename> or + <filename>gbp-</filename> are also supported but will provoke a warning when parsed by + &gbp;. + </para> -<programlisting> - [buildpackage] - export-dir = directory -</programlisting> + <para> + The keys in the + <option>key</option>=<parameter>value</parameter> pairs are named + like the command-line options of the corresponding command (with the + '--' stripped off) and can hold the same values, but see below for + details. In case of &gbp-buildpackage; and &gbp-buildpackage-rpm; + the key needs '--git-' instead of '--' stripped off. + </para> + <para> + For example, + the <xref linkend="man.gbp.buildpackage"/> manual page documents + the <option>--git-export-dir</option>=<parameter>directory</parameter> + option which can be turned into configuration file setting by + dropping the + <option>--git-</option> prefix: + </para> -<para> - Options that can be repeated on the command line take Python-like - lists in the config file. For example, - the <xref linkend="man.gbp.import.orig"/> command has the - <option>--filter</option>=<parameter>pattern</parameter> option - which can be turned into a configuration file option like this: -</para> + <programlisting> + [buildpackage] + export-dir = directory + </programlisting> -<programlisting> - [import-orig] - filter = [ '.svn', '.hg' ] -</programlisting> + <para> + Options that can be repeated on the command line take Python-like + lists in the config file. For example, + the <xref linkend="man.gbp.import.orig"/> command has the + <option>--filter</option>=<parameter>pattern</parameter> option + which can be turned into a configuration file option like this: + </para> -<para> -Boolean options can be either <option>True</option> or <option>False</option>. For example, -<xref linkend="man.gbp.import.orig"/> has the <option>--pristine-tar</option> and -<option>--no-pristine-tar</option> options which translate to: -</para> -<programlisting> - [import-orig] - pristine-tar = True -</programlisting> + <programlisting> + [import-orig] + filter = [ '.svn', '.hg' ] + </programlisting> -<para>and</para> + <para> + Boolean options can be either <option>True</option> or <option>False</option>. For example, + <xref linkend="man.gbp.import.orig"/> has the <option>--pristine-tar</option> and + <option>--no-pristine-tar</option> options which translate to: + </para> + <programlisting> + [import-orig] + pristine-tar = True + </programlisting> + + <para>and</para> -<programlisting> - [import-orig] - pristine-tar = False -</programlisting> -<para>respectively.</para> -<note> -<para> - To see the current set of values that would be applied after parsing the - configuration files, use <xref linkend="man.gbp.config"/>. -</para> -</note> -<note> -<para> - <command>gbp import-dscs</command> and <command>git-pbuilder</command> -can't be configured via <filename>gbp.conf</filename>. -</para> -</note> + <programlisting> + [import-orig] + pristine-tar = False + </programlisting> + <para>respectively.</para> + <note> + <para> + To see the current set of values that would be applied after parsing the + configuration files, use <xref linkend="man.gbp.config"/>. + </para> + </note> + <note> + <para> + <command>gbp import-dscs</command> and <command>git-pbuilder</command> + can't be configured via <filename>gbp.conf</filename>. + </para> + </note> -<para> -<xref linkend="man.gbp.create.remote.repo"/> can additionally parse remote site -configurations from <filename>gbp.conf</filename>. For example, a configuration like: -</para> + <para> + <xref linkend="man.gbp.create.remote.repo"/> can additionally parse remote site + configurations from <filename>gbp.conf</filename>. For example, a configuration like: + </para> -<programlisting> -[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 -</programlisting> + <programlisting> + [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 + </programlisting> -<para> -can be used to create remote repositories for the pkg-libvirt project using: -</para> + <para> + can be used to create remote repositories for the pkg-libvirt project using: + </para> -<programlisting> -gbp-create-remote-repo --remote-config=pkg-libvirt -</programlisting> + <programlisting> + gbp-create-remote-repo --remote-config=pkg-libvirt + </programlisting> -<para> -This can be useful if you're often creating new remote repositories for -different projects. -</para> + <para> + This can be useful if you're often creating new remote repositories for + different projects. + </para> </refsect1> <refsect1> <title>EXAMPLES</title> -<para> -An example set up for packaging work: -</para> + <para> + An example set up for packaging work: + </para> -<programlisting> - # $HOME/.gbp.conf + <programlisting> + # $HOME/.gbp.conf - [DEFAULT] - pristine-tar = True - cleaner = fakeroot debian/rules clean + [DEFAULT] + pristine-tar = True + cleaner = fakeroot debian/rules clean - [buildpackage] - export-dir = ../build-area/ + [buildpackage] + export-dir = ../build-area/ - [import-orig] - dch = False - filter = [ + [import-orig] + dch = False + filter = [ '.svn', '.hg', '.bzr', 'CVS', 'debian/*', '*/debian/*' - ] - filter-pristine-tar = True + ] + filter-pristine-tar = True - [import-dsc] - filter = [ + [import-dsc] + filter = [ 'CVS', '.cvsignore', '.hg', @@ -211,59 +210,59 @@ An example set up for packaging work: '.bzr', '.bzrignore', '.gitignore' - ] + ] - # End of file -</programlisting> -</refsect1> + # End of file + </programlisting> + </refsect1> -<refsect1> - <title>ENVIRONMENT</title> - <variablelist> + <refsect1> + <title>ENVIRONMENT</title> + <variablelist> <varlistentry> - <term><envar>GBP_CONF_FILES</envar></term> - <listitem><para>Colon separated list of files to parse. The default is -the above list of configuration files.</para></listitem> + <term><envar>GBP_CONF_FILES</envar></term> + <listitem><para>Colon separated list of files to parse. The default is + the above list of configuration files.</para></listitem> </varlistentry> <varlistentry> <term><envar>GBP_DISABLE_SECTION_DEPRECTATION</envar></term> <listitem><para>Don't print a deprecation warning when &gbp; - encounters a section starting - with <emphasis>git-</emphasis> - or <emphasis>gbp-</emphasis>. + encounters a section starting + with <emphasis>git-</emphasis> + or <emphasis>gbp-</emphasis>. </para></listitem> </varlistentry> - </variablelist> -</refsect1> + </variablelist> + </refsect1> -<refsect1> - <title>FILES</title> - <para> - See <filename>/etc/git-buildpackage/gbp.conf</filename> for an example. - </para> -</refsect1> + <refsect1> + <title>FILES</title> + <para> + See <filename>/etc/git-buildpackage/gbp.conf</filename> for an example. + </para> + </refsect1> -<refsect1> - <title>SEE ALSO</title> - <para> - <xref linkend="man.gbp.clone"/>, - <xref linkend="man.gbp.create.remote.repo"/>, - <xref linkend="man.gbp.pq"/>, - <xref linkend="man.gbp.pull"/>, - <xref linkend="man.gbp.dch"/>, - <xref linkend="man.gbp.import.dsc"/>, - <xref linkend="man.gbp.import.orig"/>, - <xref linkend="man.gbp.buildpackage"/>, - <ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html"> - <citetitle>The Git-Buildpackage Manual</citetitle></ulink> - </para> -</refsect1> -<refsect1> - <title>AUTHORS</title> - <para>&dhusername; &dhemail;</para> - <para>This manual page is based on a POD version by Jari Aalto <email>jari.aalto@cante.net</email>. - Released under license GNU GPL version 2 or (at your option) any later. + <refsect1> + <title>SEE ALSO</title> + <para> + <xref linkend="man.gbp.clone"/>, + <xref linkend="man.gbp.create.remote.repo"/>, + <xref linkend="man.gbp.pq"/>, + <xref linkend="man.gbp.pull"/>, + <xref linkend="man.gbp.dch"/>, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.buildpackage"/>, + <ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html"> + <citetitle>The Git-Buildpackage Manual</citetitle></ulink> + </para> + </refsect1> + <refsect1> + <title>AUTHORS</title> + <para>&dhusername; &dhemail;</para> + <para>This manual page is based on a POD version by Jari Aalto <email>jari.aalto@cante.net</email>. + Released under license GNU GPL version 2 or (at your option) any later. version. - </para> + </para> </refsect1> </refentry> |