man pages aren't updated

man pages aren't updated

[Han Pingtian]

Hi,

I just noticed that some man page, such as zshexpn, isn't updated after
a new git pull & make. If I clone a new git repo, then looks like all
man pages' size are zero. Not sure what's wrong. 

Thanks.

Re: man pages aren't updated

[Daniel Shahaf]

Han Pingtian wrote on Tue, Nov 01, 2016 at 11:46:38 +0800:
> I just noticed that some man page, such as zshexpn, isn't updated after
> a new git pull & make. If I clone a new git repo, then looks like all
> man pages' size are zero. Not sure what's wrong. 

Works for me.  Looking at the relevant Doc/Makefile.in targets, an empty
file is what I'd expect if the $(YODL) macro is not a functioning yodl
program.  (They use «> $$target».)  What's the value of $(YODL) on your
system?  Does that program exist and work?

% git clone --reference ~/src/zsh git://git.code.sf.net/p/zsh/code
% cd code/
% Util/preconfig
% ./configure -q
% make -sC Doc
% zstat +size Doc/*.1 
Doc/zsh.1 17530
Doc/zshall.1 17618
Doc/zshbuiltins.1 131224
Doc/zshcalsys.1 39388
Doc/zshcompctl.1 28558
Doc/zshcompsys.1 233061
Doc/zshcompwid.1 51383
Doc/zshcontrib.1 198013
Doc/zshexpn.1 127663
Doc/zshmisc.1 101441
Doc/zshmodules.1 161653
Doc/zshoptions.1 71476
Doc/zshparam.1 70826
Doc/zshroadmap.1 8147
Doc/zshtcpsys.1 36940
Doc/zshzftpsys.1 30988
Doc/zshzle.1 107346

Re: man pages aren't updated

[Han Pingtian]

On Tue, Nov 01, 2016 at 03:37:01PM +0000, Daniel Shahaf wrote:
> Works for me.  Looking at the relevant Doc/Makefile.in targets, an empty
> file is what I'd expect if the $(YODL) macro is not a functioning yodl
> program.  (They use «> $$target».)  What's the value of $(YODL) on your
> system?  Does that program exist and work?

Thanks! I got the new man page after installing yodl.

Re: man pages aren't updated

[Daniel Shahaf]

Han Pingtian wrote on Wed, Nov 02, 2016 at 10:09:16 +0800:
> On Tue, Nov 01, 2016 at 03:37:01PM +0000, Daniel Shahaf wrote:
> > Works for me.  Looking at the relevant Doc/Makefile.in targets, an empty
> > file is what I'd expect if the $(YODL) macro is not a functioning yodl
> > program.  (They use «> $$target».)  What's the value of $(YODL) on your
> > system?  Does that program exist and work?
> 
> Thanks! I got the new man page after installing yodl.

I suppose configure could print a warning if yodl wasn't found.

Re: man pages aren't updated

[Han Pingtian]

On Wed, Nov 02, 2016 at 03:00:13AM +0000, Daniel Shahaf wrote:
> Han Pingtian wrote on Wed, Nov 02, 2016 at 10:09:16 +0800:
> > On Tue, Nov 01, 2016 at 03:37:01PM +0000, Daniel Shahaf wrote:
> > > Works for me.  Looking at the relevant Doc/Makefile.in targets, an empty
> > > file is what I'd expect if the $(YODL) macro is not a functioning yodl
> > > program.  (They use «> $$target».)  What's the value of $(YODL) on your
> > > system?  Does that program exist and work?
> > 
> > Thanks! I got the new man page after installing yodl.
> 
> I suppose configure could print a warning if yodl wasn't found.

Yes, it prints a warning like this:

checking for yodl... no

but I neglected this message.

Re: man pages aren't updated

[Daniel Shahaf]

Han Pingtian wrote on Wed, Nov 02, 2016 at 13:53:43 +0800:
> On Wed, Nov 02, 2016 at 03:00:13AM +0000, Daniel Shahaf wrote:
> > Han Pingtian wrote on Wed, Nov 02, 2016 at 10:09:16 +0800:
> > > On Tue, Nov 01, 2016 at 03:37:01PM +0000, Daniel Shahaf wrote:
> > > > Works for me.  Looking at the relevant Doc/Makefile.in targets, an empty
> > > > file is what I'd expect if the $(YODL) macro is not a functioning yodl
> > > > program.  (They use «> $$target».)  What's the value of $(YODL) on your
> > > > system?  Does that program exist and work?
> > > 
> > > Thanks! I got the new man page after installing yodl.
> > 
> > I suppose configure could print a warning if yodl wasn't found.
> 
> Yes, it prints a warning like this:
> 
> checking for yodl... no
> 
> but I neglected this message.

That's just a routine diagnostic buried among hundreds of its kind;
people won't pay it any attention.  (And configure -q hides it.)  I meant
a new, explicit warning: "yodl not found; documentation won't be built".

Re: man pages aren't updated

[Han Pingtian]

On Wed, Nov 02, 2016 at 04:38:17PM +0000, Daniel Shahaf wrote:
> That's just a routine diagnostic buried among hundreds of its kind;
> people won't pay it any attention.  (And configure -q hides it.)  I meant
> a new, explicit warning: "yodl not found; documentation won't be built".

Agree. It would be good if there was such a message.

Re: man pages aren't updated

[Bart Schaefer]

On Nov 3,  8:51am, Han Pingtian wrote:
}
} On Wed, Nov 02, 2016 at 04:38:17PM +0000, Daniel Shahaf wrote:
} > That's just a routine diagnostic buried among hundreds of its kind;
} > people won't pay it any attention.  (And configure -q hides it.)  I meant
} > a new, explicit warning: "yodl not found; documentation won't be built".
} 
} Agree. It would be good if there was such a message.

There's a bit of a conflict here:  If you download the tarball, instead of
pulling from git, then you're supposed to also download the documentation
tarball rather than (need to) build the documentation yourself.  So the
message appropriate for a developer might not be appropriate for a
package installer or other user.