Yodl 4 required?

Yodl 4 required?

[Bart Schaefer]

I've got yodl installed from (I believe) macports on my laptop, and
it's yodl version 3.05.01.
On my Ubuntu host I have yodl version 4.02.02.

With version 4.02.02, all is well.  With 3.05.01, I get these errors
trying to build zsh.texi:

./zsh.texi:18929: Prev field of node `Character Highlighting' not pointed to.
./zsh.texi:16894: This node (Zle Widgets) has the bad Next.
./zsh.texi:17432: Next field of node `Standard Widgets' not pointed to
(perhaps incorrect sectioning?).
./zsh.texi:18929: This node (Character Highlighting) has the bad Prev.
./zsh.texi:6361: Node `Filename Expansion' lacks menu item for `Notes'
despite being its Up target.
./zsh.texi:6361: Node `Filename Expansion' lacks menu item for ``='
expansion' despite being its Up target.
./zsh.texi:6361: Node `Filename Expansion' lacks menu item for `Static
named directories' despite being its Up target.
./zsh.texi:6361: Node `Filename Expansion' lacks menu item for
`Dynamic named directories' despite being its Up target.

Re: Yodl 4 required?

[dana]

On Sun 13 Mar 2022, at 16:22, Bart Schaefer wrote:
> I've got yodl installed from (I believe) macports on my laptop, and
> it's yodl version 3.05.01. ...
>
> With version 4.02.02, all is well.  With 3.05.01, I get these errors
> trying to build zsh.texi:

I have 3.05.01, installed from here...

  https://packages.macports.org/yodl/yodl-3.05.01_0.darwin_18.x86_64.tbz2

... and it seems to work OK for me. That's what i used when i built 5.8.1.

I still don't really know how the Yodl/Texinfo stuff works but maybe the
problem is with the latter?

In addition to Yodl itself i have texi2html 5.0 and texinfo 6.8 installed
from Homebrew, though it says texinfo is 'keg only' because macOS provides
it already.

Probably also worth mentioning i'm still on Catalina. I haven't tried
building on Monterey yet.

dana

Re: Yodl 4 required?

[Bart Schaefer]

On Sun, Mar 13, 2022 at 6:58 PM dana <dana@dana.is> wrote:
>
> I still don't really know how the Yodl/Texinfo stuff works but maybe the
> problem is with the latter?

Yes, that seems to be it:
makeinfo (GNU texinfo) 4.8 fails
texi2any (GNU texinfo) 6.7 works

> In addition to Yodl itself i have texi2html 5.0 and texinfo 6.8 installed
> from Homebrew, though it says texinfo is 'keg only' because macOS provides
> it already.

Hmm, RE "macOS provides" ...

> Probably also worth mentioning i'm still on Catalina.

I am too.

Anyway, we have a configure test for the version of yodl, do we
perhaps also need one for the version of makeinfo (or its
replacement)?

In any case it was Daniel's commit 1168c6c3 that broke this ... I
guess I haven't tried "make info" on this mac in several months.

PATCH: Fix node references and menu (was Re: Yodl 4 required?)

[Bart Schaefer]

[-- Attachment #1: Type: text/plain, Size: 259 bytes --]

On Sun, Mar 13, 2022 at 8:34 PM Bart Schaefer <schaefer@brasslantern.com> wrote:
>
> makeinfo (GNU texinfo) 4.8 fails
> texi2any (GNU texinfo) 6.7 works

This repairs the cross-references.  texi2any seems to be too
forgiving, because these really were wrong.

[-- Attachment #2: noderefs.txt --]
[-- Type: text/plain, Size: 1273 bytes --]

diff --git a/Doc/Zsh/expn.yo b/Doc/Zsh/expn.yo
index c53ca645e..00cbbcd27 100644
--- a/Doc/Zsh/expn.yo
+++ b/Doc/Zsh/expn.yo
@@ -1897,6 +1897,13 @@ The tt(PUSHD_MINUS)
 option exchanges the effects of `tt(~PLUS())' and `tt(~-)' where they are
 followed by a number.
 
+startmenu()
+menu(Dynamic named directories)
+menu(Static named directories)
+menu(`=' expansion)
+menu(Notes)
+endmenu()
+
 texinode(Dynamic named directories)(Static named directories)()(Filename Expansion)
 subsect(Dynamic named directories)
 cindex(directories, named, dynamic)
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index f0165c7c1..2d033a0a1 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -733,7 +733,7 @@ enditem()
 enditem()
 
 texinode(Zle Widgets)(User-Defined Widgets)(Zle Builtins)(Zsh Line Editor)
-sect(Widgets)
+sect(Zle Widgets)
 cindex(widgets)
 All actions in the editor are performed by `widgets'.  A widget's job is
 simply to perform some small action.  The ZLE commands that key sequences
@@ -2627,7 +2627,7 @@ argument, multiple words will be selected.
 )
 enditem()
 
-texinode(Character Highlighting)()(Zle Widgets)(Zsh Line Editor)
+texinode(Character Highlighting)()(Standard Widgets)(Zsh Line Editor)
 sect(Character Highlighting)
 
 vindex(zle_highlight, setting)

Re: PATCH: Fix node references and menu (was Re: Yodl 4 required?)

[Daniel Shahaf]

Bart Schaefer wrote on Sun, Mar 13, 2022 at 21:00:16 -0700:
> On Sun, Mar 13, 2022 at 8:34 PM Bart Schaefer <schaefer@brasslantern.com> wrote:
> >
> > makeinfo (GNU texinfo) 4.8 fails
> > texi2any (GNU texinfo) 6.7 works
> 
> This repairs the cross-references.  texi2any seems to be too
> forgiving, because these really were wrong.

Sorry for the breakage and thanks for fixing this.  What should I do
differently next time?  I had built the documentation (all formats)
before pushing that, and here (Debian) «make info» still passes on
master if I locally revert your fix.

I guess I should try to build on a more bleeding-edge distro (e.g., in
Debian sid)?

Cheers,

Daniel

Re: PATCH: Fix node references and menu (was Re: Yodl 4 required?)

[Bart Schaefer]

On Sun, Apr 10, 2022 at 3:07 PM Daniel Shahaf <d.s@daniel.shahaf.name> wrote:
>
> Bart Schaefer wrote on Sun, Mar 13, 2022 at 21:00:16 -0700:
> > On Sun, Mar 13, 2022 at 8:34 PM Bart Schaefer <schaefer@brasslantern.com> wrote:
> > >
> > > makeinfo (GNU texinfo) 4.8 fails
> > > texi2any (GNU texinfo) 6.7 works
> >
> > This repairs the cross-references.  texi2any seems to be too
> > forgiving, because these really were wrong.
>
> Sorry for the breakage and thanks for fixing this.  What should I do
> differently next time?

Seems to come down to:
1) If you add new texinode(this)(next)(prev)(up) entries, the (up)
section needs a startmenu()/endmenu() that references each of the
(this).
2) If there is a sect(thing) or subsect(thing) following the
texinode(this), (thing) must be exactly the same as (this).

There are probably nuances I'm missing, but the above is what fixed
the errors from the old makeinfo.

>  I had built the documentation (all formats)
> before pushing that, and here (Debian) «make info» still passes on
> master if I locally revert your fix.

At some point the texi packages re-implemented "makeinfo" in terms of texi2any.

texi2any is supposed to warn about missing cross-references unless the
--no-validate flag is passed, but it doesn't catch all the same ones
that the older makeinfo does.

> I guess I should try to build on a more bleeding-edge distro (e.g., in
> Debian sid)?

Unless texi2any has been fixed, using a newer distro is not going to
help ... you need an older one.