Re: example macro prototype is somewhat malformed

[Patrice Dumas]

On Tue, May 13, 2014 at 08:13:08AM -0600, Eric Blake wrote:
> On 05/13/2014 06:54 AM, Marijn Schouten (hkBst) wrote:
> > On
> > https://www.gnu.org/savannah-checkouts/gnu/m4/manual/m4-1.4.17/html_node/Manual.html#Manual
> > 
> > the example macro prototype is somewhat malformed:
> > 
> > ===
> > 
> > Composite: example (string, [count = ‘1’]
> > 
> >     [argument]This is a sample prototype. There is not really a macro
> 
> Thanks for the report.
> 
> > In the first line, [argument] fell off the line, there is no closing paren.
> 
> I'm suspecting a bug in texinfo (hence the added cc); this is the source
> code for that line:
> 
> @deffn Composite example (@var{string}, @dvar{count, 1}, @
>   @address@hidden)
> This is a sample prototype.  There is not really a macro named

Ok, I expanded the macros and indeed, the problem is that there are @c
that swallow the end of lines.  After user-defined @-macro expansion,
the texinfo indeed reads:

@deffn Composite example (@var{string}, @address@hidden = @address@hidden@c, @
  @address@hidden@address@hidden@dots{})

The @c on the @deffn line swallows the end of line, the @c in the second
line swallows the "@dots{})"?  The Info output is also incorrect:

 -- Composite: example (STRING, [COUNT = '1']
     [ARGUMENT]This is a sample prototype.  There is not really a macro

My guess is that simply removing the @c in the user @-macro definition
would fix this issue, in addition to being simpler, as in

@c @ovar{ARG}
@c -------------------
@c The ARG is an optional argument.  To be used for macro arguments in
@c their documentation (@defmac).
@macro ovar{varname}
@address@hidden@r{]}
@end macro


-- 
Pat