Re: unclear m4 documentation formatting

[Eric Blake]

On 01/11/2017 05:03 AM, Tom Baker wrote:
> While in emacs I called up the m4 info file, and read up to section
> "1.4 Using this manual".
> 
> There I saw:
> 
> <begin snip>
> 
>    As each of the predefined macros in 'm4' is described, a prototype
> call of the macro will be shown, giving descriptive names to the
> arguments, e.g.,
> 
>  -- Composite: example (STRING, [COUNT = '1']
>      [ARGUMENT]This is a sample prototype.  There is not really a macro
>      named 'example', but this documents that if there were, it would be
> 
> <end snip>
> 
> What is "[ARGUMENT]"?  I assumed it was the start of that text.

Thanks for the report.  This was fixed here:
http://git.sv.gnu.org/cgit/m4.git/commit/?h=branch-1.4&id=f5ef8cf

> m4 manual is:
> manual (22 September 2013) for GNU M4 (version 1.4.17)

The just-released 1.4.18 has the fix, where I see:

> arguments, e.g.,
> 
>  -- Composite: example (STRING, [COUNT = '1'], [ARGUMENT]...)
>      This is a sample prototype.  There is not really a macro named
>      'example', but this documents that if there were, it would be a

in the same section of the info manual.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature