[Eli Zaretskii <address@hidden>] Re: Errors running texi2dvi on r5rs.texi from the Guile docs distro

[Neil Jerram]

We've uncovered some Texinfo syntax errors in the r5rs.texi from the
guile-doc distribution.  The symptom is that r5rs.dvi doesn't build
smoothly.

We could just fix these errors, but perhaps there is a master source
for this file - in the Texinfo version - and the Right Thing To Do is
to resync with the master copy.  (Or get the errors fixed in that
master copy and then resync.)

Does anyone know whether there is a master source for r5rs.texi?  If
so, where is it?

Thanks,
        Neil


------- Start of forwarded message -------
Date: Sun, 29 Oct 2000 16:23:41 +0200 (IST)
From: Eli Zaretskii <address@hidden>
To: Neil Jerram <address@hidden>
cc: address@hidden, "Dale P. Smith" <address@hidden>,
        "K. Berry" <address@hidden>
Subject: Re: Errors running texi2dvi on r5rs.texi from the Guile docs distro
Message-ID: <address@hidden>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII


On 28 Oct 2000, Neil Jerram wrote:

> ! Unbalanced parentheses in @def.
> @defunargs ...age {Unbalanced parentheses in @def}
>                                                   @fi @interlinepenalty 
> =100...
> 
> @deffnheader ...p @defname address@hidden {#3}
>                                                   @endgroup @catcode 
> address@hidden 
> 
> @spacesplitfoo ...lax address@hidden #1{#2}{#3#4}
>                                                   @fi 
> l.605 ...cedure} (vector-ref @var{vector} @var{k})

This is triggered by the following line:

  @deffn {procedure} (vector-ref @var{vector} @var{k})

This seems to be in wrong format.  The template for @deffn is like this:

  @deffn CATEGORY NAME ARGUMENTS...

Texinfo allows parentheses only in the ARGUMENTS part, which is violated 
by the above.  Put the parens around (vector k) only, and it will work.

Since this is Scheme, I'd guess that you don't want the parens at all, 
but you want instead to say this:

  @deffn {procedure} vector-ref vector k

(no need for the @var{}, either, in this case).

Karl, I guess this limitation wrt the parens should be added to the
Texinfo manual, since I don't see it saying anything about the parens
around ARGUMENTS only.  If you agree, I will send a patch.

(Btw, makeinfo seems to accept the parens in the above example.  Is it a
limitation of texinfo.tex?)

> I'm afraid I don't know enough to know whether these errors indicate
> bugs in the source or bugs in texi2dvi.  But r5rs.texi is a very
> widely distributed document, so I would tend to suspect texi2dvi.

I'm not sure.  I'm guessing that these @deffn lines were added only 
recently (they are very few), in which case these late additions are to 
blame.

------- End of forwarded message -------