Re: [PATCH] doc: fix style issues in the display of macro optional arguments

[Eric Blake]

On 07/22/2012 03:49 AM, Akim Demaille wrote:
> -8<-
> Hi all,
> 
> I was reading at the documentation of m4_map_args_pair, which reads as
> follows:
> 
>  -- Macro: m4_map_args_pair (MACRO, [MACRO-END = `macro'], ARG...)
>      For every pair of arguments ARG, invoke MACRO with two arguments.
>      If there is an odd number of arguments, invoke MACRO-END, which
>      defaults to MACRO, with the remaining argument.
> 
> The way the default value of MACRO-END is display is wrong.
> -8<-
> 
> * doc/autoconf.texi (@dvarv): New.
> Use it where optional macro arguments default to other arguments.
> ---
>  doc/autoconf.texi | 18 +++++++++++++-----
>  1 file changed, 13 insertions(+), 5 deletions(-)

ACK with one tweak.  Do you still have push rights, or do I need to help
out?

> 
> diff --git a/doc/autoconf.texi b/doc/autoconf.texi
> index 927921c..b542c8e 100644
> --- a/doc/autoconf.texi
> +++ b/doc/autoconf.texi
> @@ -26,6 +26,14 @@
>  @address@hidden = @address@hidden
>  @end macro
> 
> address@hidden @dvarv(ARG, DEFAULT-VAR)
> address@hidden ------------------------
> address@hidden Same as @dvar{ARG, @var{DEFAULT-VAR}}, but with the superfluous
> address@hidden @samp around DEFAULT-VAR.

s/with the superfluous @samp/with @var instead of @samp/

-- 
Eric Blake   address@hidden    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature