[git-buildpackage] [PATCH] doc: expand --git-pbuilder-options docs

[Guido Günther]

Hi Ken,
On Fri, Aug 11, 2017 at 11:04:45AM -0600, Ken Dreyer wrote:
> Give an example of how to use the --git-pbuilder-options option, and
> explain how it interacts with git-pbuilder.
> ---
>  docs/manpages/gbp-buildpackage.sgml | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/manpages/gbp-buildpackage.sgml b/docs/manpages/gbp-buildpackage.sgml
> index 31faabc..a246e68 100644
> --- a/docs/manpages/gbp-buildpackage.sgml
> +++ b/docs/manpages/gbp-buildpackage.sgml
> @@ -417,7 +417,13 @@
>              <para>
>                Options to pass to pbuilder when building via &git-pbuilder; (either
>                via <option>--git-pbuilder</option>, <option>--git-qemubuilder</option>
> -              or the corresponding configuration file options).
> +	      or the corresponding configuration file options). For example, to
> +	      tell pbuilder to use an alternate .pbuilderrc file, you may run
> +	      &gbp-buildpackage; with
> +	      <option>--git-pbuilder-options="--configfile
> +	      /tmp/my/pbuilderrc"</option>". If unset, no
> +	      <replacable>GIT_PBUILDER_OPTIONS</replacable> environment
> +	      variable will be passed to <command>git-pbuilder</command>.

Looks good. One thing. If the variable is unset gbp is supposed to not
_touch_ GIT_PBUILDER_OPTIONS so a:

     GIT_PBUILDER_OPTIONS="--conf /foo/pbuilderrc" gbp buildpackage …

is supposed to work as well. So I'd rather write:

   …
     or the corresponding configuration file options). It does so
     by using the <envar>GIT_PBUILDER_OPTIONS</envar> environment
     variable to pass options to &git-pbuilder;.
     </para>
     <para>
     For example, to tell pbuilder to use an alternate .pbuilderrc file,
     you may run &gbp-buildpackage; with
     <option>--git-pbuilder-options="--configfile
     /tmp/my/pbuilderrc"</option>".
     </para>
     <para>
     If unset the <envar>GIT_PBUILDER_OPTIONS</envar> environment
     variable will be left untouched.
     </para>
   …

Alternatively we could only have the envvar part there and add another
example to the EXAMPLES section.

Cheeers,
 -- Guido


>              </para>
>            </listitem>
>  	</varlistentry>
> -- 
> 2.13.3
> 
> _______________________________________________
> git-buildpackage mailing list
> git-buildpackage at lists.sigxcpu.org
> http://lists.sigxcpu.org/mailman/listinfo/git-buildpackage
>