Re: In an @example, @comment at EOL swallows the following newline.

[Alan Mackenzie]

Hello, Eli and Gavin.

On Mon, Jan 01, 2018 at 18:00:46 +0200, Eli Zaretskii wrote:
> > From: Gavin Smith <address@hidden>
> > Date: Mon, 1 Jan 2018 10:50:15 +0000
> > Cc: address@hidden

> > I believe the comment is supposed to include the linefeed.

I'm not sure what this means.  In most situations in texinfo source,
linefeeds are not significant, so it doesn't seem to make sense to say
that comments include their terminating LFs.  Are there any situations
where NOT including the LF in the comment would break something?

> > In this context it doesn't seem very useful, but changing it would
> > be difficult and would be likely to break something else.

OK.  cc-mode.info (part of Emacs) has been broken for an unknown time
because of this bug.  If it's not sensible to fix it, how about emitting
a warning message, warning of the (probably) broken behaviour?

> I believe you are right.  One place where this is definitely used is
> in some macros.

The actual source in cc-mode.texi which showed up the bug was indeed in
a macro, namely:

    @macro hereFn{func}
    <- @address@hidden
    @end macro

.  This macro was committed on 2003-05-12.  The @c at EOL2 looks like a
workaround for some glitch in an earlier version of makeinfo.  (As a
matter of interest, makeinfo 4.13 builds the source correctly, whether
or not the "@c" is present.).

This workaround could be present in a lot of files.texi that were being
actively modified around 15 years ago.  Again, would it be possible to
output a warning for this situation, and possibly document it in
texinfo's own documentation?

Thanks!

-- 
Alan Mackenzie (Nuremberg, Germany).