"make info" fails with new versions of texinfo

"make info" fails with new versions of texinfo

[Frank Terbeck]

Hi list,

on IRC someone noticed "make info" breaking.

I then tried building info documentation with texinfo versions 4.13 and
5.1, and indeed the newer version fails with the following output:

[snip]
makeinfo ./zsh.texi
./zsh.texi:433: warning: @item missing argument
./zsh.texi:1083: warning: @item missing argument
./zsh.texi:1654: warning: @item missing argument
./zsh.texi:14714: warning: @item missing argument
./zsh.texi:22674: @itemx must follow @item
./zsh.texi:23289: warning: @item missing argument
./zsh.texi:23434: warning: @item missing argument
./zsh.texi:23867: warning: @item missing argument
./zsh.texi:23895: warning: @item missing argument
./zsh.texi:25010: warning: @item missing argument
./zsh.texi:25013: warning: @item missing argument
./zsh.texi:25016: warning: @item missing argument
make[1]: *** [zsh.info] Error 1
[snap]

I have virtually no idea what's going on. Maybe someone with stronger
texinfo-fu can take a look? I am Cc:ing Frank B. Brokken, who appears to
be the yodl-guy, according to http://yodl.sourceforge.net. If this is a
case of yodl generating texinfo sources incompatible with newer versions
of texinfo maybe he can help.

Just a short recipe for Frank to reproduce, if he wants to:

[snip]
% git clone git://git.code.sf.net/p/zsh/code zsh
% cd zsh
% ./Util/preconfig
% ./configure
% make info
[snap]

The last step, at least with texinfo version 5.1, will fail during a
"makeinfo" call as shown further above.


Regards, Frank

-- 
In protocol design, perfection has been reached not when there is
nothing left to add, but when there is nothing left to take away.
                                                  -- RFC 1925

Re: "make info" fails with new versions of texinfo

[Frank Terbeck]

Frank Terbeck wrote:
[...]
> I then tried building info documentation with texinfo versions 4.13 and
> 5.1, and indeed the newer version fails with the following output:

Oh, I forgot the yodl versions, that were used: I used version 3.00 and
the guy on IRC used 3.01.

Re: "make info" fails with new versions of texinfo

[Peter Stephenson]

On Fri, 12 Apr 2013 12:11:05 +0200
Frank Terbeck <ft@bewatermyfriend.org> wrote:
> Oh, I forgot the yodl versions, that were used: I used version 3.00 and
> the guy on IRC used 3.01.

I can't get 3.01 to do anything sensible, I get a fatal error you're
obviously not getting.  However, the .texi file I get from my version,
which is very old, gives output that corresponds to the warnings and
errors you got:

makeinfo ./zsh.texi
./zsh.texi:433: warning: @item missing argument
./zsh.texi:1083: warning: @item missing argument
./zsh.texi:1654: warning: @item missing argument
./zsh.texi:14714: warning: @item missing argument
./zsh.texi:22674: @itemx must follow @item
./zsh.texi:23289: warning: @item missing argument
./zsh.texi:23434: warning: @item missing argument
./zsh.texi:23867: warning: @item missing argument
./zsh.texi:23895: warning: @item missing argument
./zsh.texi:25010: warning: @item missing argument
./zsh.texi:25013: warning: @item missing argument
./zsh.texi:25016: warning: @item missing argument
make[1]: *** [zsh.info] Error 1

I haven't got the latest texinfo because my Linux distribution is out of
date, because it made the boot partition too small and now refuses to
upgrade, but I can make reasonable guesses.

The warnings about empty items do indeed correspond to empty items.
They come from the zsh macro, not Yodl's macros; it's deliberate.  I've
removed it below, but it does look like it might be better to have a bit
more space afterwards.  There are probably better ways of doing that ---
like explicitly inserting a blank line, so that's what I've done.  With
any luck the result is very similar.

The error looks like it might be because texinfo is getting confused by
a line split.  Does putting it back together make a difference?

diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 2991c1f..4a436da 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -4414,8 +4414,7 @@ tt(ambiguous), tt(special-dirs), tt(list-suffixes) and tt(file-sort)
 described above.
 )
 findex(_pick_variant)
-xitem(tt(_pick_variant) [ tt(-b) var(builtin-label) ] [ tt(-c)
-var(command) ] [ tt(-r) var(name) ])
+xitem(tt(_pick_variant) [ tt(-b) var(builtin-label) ] [ tt(-c) var(command) ] [ tt(-r) var(name) ])
 item(   var(label)tt(=)var(pattern) ... var(label) [ var(args) ... ])(
 This function is used to resolve situations where a single command name
 requires more than one type of handling, either because it
diff --git a/Doc/ztexi.yo b/Doc/ztexi.yo
index ed0236b..513452b 100644
--- a/Doc/ztexi.yo
+++ b/Doc/ztexi.yo
@@ -193,8 +193,8 @@ def(startlist)(0)(\
   startitem()\
 )
 def(endlist)(0)(\
-  NOTRANS(@item)+NL()\
-  enditem()\
+  enditem()+NL()\
+  NOTRANS(@sp 1)\
 )
 def(list)(1)(\
   item(ARG1)()\

-- 
Peter Stephenson <p.w.stephenson@ntlworld.com>
Web page now at http://homepage.ntlworld.com/p.w.stephenson/

Re: "make info" fails with new versions of texinfo

[Frank Terbeck]

Peter Stephenson wrote:
[...]
> The warnings about empty items do indeed correspond to empty items.
> They come from the zsh macro, not Yodl's macros; it's deliberate.  I've
> removed it below, but it does look like it might be better to have a bit
> more space afterwards.  There are probably better ways of doing that ---
> like explicitly inserting a blank line, so that's what I've done.  With
> any luck the result is very similar.
>
> The error looks like it might be because texinfo is getting confused by
> a line split.  Does putting it back together make a difference?

Yes, now the build succeeds. The only remaining output are a few
warnings:

[snip]
makeinfo ./zsh.texi
./zsh.texi:25009: warning: @item missing argument
./zsh.texi:25012: warning: @item missing argument
./zsh.texi:25015: warning: @item missing argument
make[1]: Leaving directory `/home/hawk/src/sys/zsh/Doc'
[snap]

But I end up with an infodoc version of the manual just fine.


Regards, Frank

Re: "make info" fails with new versions of texinfo

[Peter Stephenson]

On Fri, 12 Apr 2013 22:48:09 +0200
Frank Terbeck <ft@bewatermyfriend.org> wrote:
> Yes, now the build succeeds. The only remaining output are a few
> warnings:
> 
> [snip]
> makeinfo ./zsh.texi
> ./zsh.texi:25009: warning: @item missing argument
> ./zsh.texi:25012: warning: @item missing argument
> ./zsh.texi:25015: warning: @item missing argument
> make[1]: Leaving directory `/home/hawk/src/sys/zsh/Doc'
> [snap]

That appears to be in the source itself; we just need to add an
argument.

diff --git a/Doc/Zsh/mod_curses.yo b/Doc/Zsh/mod_curses.yo
index d3f8ad2..cd7e260 100644
--- a/Doc/Zsh/mod_curses.yo
+++ b/Doc/Zsh/mod_curses.yo
@@ -84,11 +84,11 @@ The subcommand tt(position) writes various positions associated with
 var(targetwin) into the array named var(array).
 These are, in order:
 startsitem()
-sitem()(The y and x coordinates of the cursor relative to the top left
+sitem(*)(The y and x coordinates of the cursor relative to the top left
 of var(targetwin))
-sitem()(The y and x coordinates of the top left of var(targetwin) on the
+sitem(*)(The y and x coordinates of the top left of var(targetwin) on the
 screen)
-sitem()(The size of var(targetwin) in y and x dimensions.)
+sitem(*)(The size of var(targetwin) in y and x dimensions.)
 endsitem()
 
 Outputting characters and strings are achieved by tt(char) and tt(string)

-- 
Peter Stephenson <p.w.stephenson@ntlworld.com>
Web page now at http://homepage.ntlworld.com/p.w.stephenson/

Re: "make info" fails with new versions of texinfo

[Frank Terbeck]

Peter Stephenson wrote:
> On Fri, 12 Apr 2013 22:48:09 +0200
> Frank Terbeck <ft@bewatermyfriend.org> wrote:
>> [snip]
>> makeinfo ./zsh.texi
>> ./zsh.texi:25009: warning: @item missing argument
>> ./zsh.texi:25012: warning: @item missing argument
>> ./zsh.texi:25015: warning: @item missing argument
>> make[1]: Leaving directory `/home/hawk/src/sys/zsh/Doc'
>> [snap]
>
> That appears to be in the source itself; we just need to add an
> argument.

You are correct! With this patch on top of the other, I'm getting a
warning-less build using yodl 3.00 and texinfo 5.1!

Regards, Frank