Installation fails because the documentation is not building

Installation fails because the documentation is not building

[Vincent Stemen]

Hi.

On FreeBSD of course.

With the source from the git repository, "gmake install" fails on the
documentation.  yodl version 2.15.2 is installed.

Here is the output from "gmake" from the point where it entered the Doc
directory.

    gmake[1]: Entering directory `/home/vince/ports/zsh-20110218/work/zsh-20110218/Doc'
    yodl  -o zsh.texi -I. -w ztexi.yo version.yo zsh.yo; \
            test -f zsh.texi
    Zsh Yodl-to-TeXinfo converter
    Including file Zsh/manual.yo
    Including file Zsh/manmodmenu.yo
    Including file Zsh/intro.yo
    [ ... a bunch more includes ] 
    Including file Zsh/index.yo
    case 'yodl ' in :*) touch ../META-FAQ ;; *) \
                yodl  -I. META-FAQ.yo | sed -e '/NEXTLINE/N' -e '/DELLINE/d' -e '/^SECTHEAD$/{N;s/^SECTHEAD.//;h;s/./-/g;H;g;}' -e 's/  *$//' > ../META-FAQ \
            ;; esac
    gmake[1]: Leaving directory `/home/vince/ports/zsh-20110218/work/zsh-20110218/Doc'

It does not appear to have any errors.

Here is the output from "gmake install" from the point where it entered the Doc
directory.

    gmake[1]: Entering directory `/home/vince/ports/zsh-20110218/work/zsh-20110218/Doc'
    /bin/sh ../mkinstalldirs /usr/share/man/man1
    for file in zsh.1 zshbuiltins.1 zshcalsys.1 zshcompctl.1 zshcompwid.1 zshcompsys.1 zshcontrib.1 zshexpn.1 zshmisc.1 zshmodules.1 zshoptions.1 zshparam.1 zshroadmap.1 zshtcpsys.1 zshzftpsys.1 zshzle.1 zshall.1; do \
                test -s ./$file || exit 1; \
                /usr/bin/install -c -m 644 ./$file /usr/share/man/man1/`echo $file | sed 's|zsh|zsh|'` || exit 1; \
            done
    gmake[1]: *** [install.man] Error 1
    gmake[1]: Leaving directory `/home/vince/ports/zsh-20110218/work/zsh-20110218/Doc'
    gmake: *** [install.man] Error 2

I assume it is failing on the "test -s" statement, because when I look in the
Doc directory, all the man files ending in ".1" are zero length.

Any ideas?

Re: Installation fails because the documentation is not building

[Wayne Davison]

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

On Sun, Feb 20, 2011 at 7:14 PM, Vincent Stemen <vince.lists@hightek.org>wrote:

> I assume it is failing on the "test -s" statement, because when I look in
> the
> Doc directory, all the man files ending in ".1" are zero length.
>

The Doc Makefile will create 0-length *.1 files if it doesn't think that
yodl is around. Perhaps you ran make before yodl was installed, and didn't
remove those files?  It looks like only a "make realclean"  will remove the
*.1 files (and you'd probably want to just manually remove the *.1 files
instead of going to that extreme).

I'm not sure why none of the lesser clean targets will clean up the *.1
files, though.  Maybe it is to help folks who don't have yodl installed and
get the *.1 files manually?

..wayne..

Re: Installation fails because the documentation is not building

[Mikael Magnusson]

On 21 February 2011 06:55, Wayne Davison <wayned@users.sourceforge.net> wrote:
> On Sun, Feb 20, 2011 at 7:14 PM, Vincent Stemen <vince.lists@hightek.org>wrote:
>
>> I assume it is failing on the "test -s" statement, because when I look in
>> the
>> Doc directory, all the man files ending in ".1" are zero length.
>>
>
> The Doc Makefile will create 0-length *.1 files if it doesn't think that
> yodl is around. Perhaps you ran make before yodl was installed, and didn't
> remove those files?  It looks like only a "make realclean"  will remove the
> *.1 files (and you'd probably want to just manually remove the *.1 files
> instead of going to that extreme).
>
> I'm not sure why none of the lesser clean targets will clean up the *.1
> files, though.  Maybe it is to help folks who don't have yodl installed and
> get the *.1 files manually?

The .1 files are distributed in the release tarballs so people don't
need yodl to build those.

-- 
Mikael Magnusson

Re: Installation fails because the documentation is not building

[Vincent Stemen]

On Sun, Feb 20, 2011 at 09:55:51PM -0800, Wayne Davison wrote:
> On Sun, Feb 20, 2011 at 7:14 PM, Vincent Stemen <vince.lists@hightek.org>wrote:
> 
> > I assume it is failing on the "test -s" statement, because when I look in
> > the
> > Doc directory, all the man files ending in ".1" are zero length.
> >
> 
> The Doc Makefile will create 0-length *.1 files if it doesn't think that
> yodl is around. Perhaps you ran make before yodl was installed, and didn't
> remove those files?  It looks like only a "make realclean"  will remove the
> *.1 files (and you'd probably want to just manually remove the *.1 files
> instead of going to that extreme).
> 
> I'm not sure why none of the lesser clean targets will clean up the *.1
> files, though.  Maybe it is to help folks who don't have yodl installed and
> get the *.1 files manually?
> 
> ..wayne..

Ah.  Yes, that was the problem.  Manually removing them worked.  Thanks.  

Yes, I did build from the repo source prior to installing yodl for
testing the sh compatibility patches.  

Seems to me that the installation code could use some improvement here.
The build was successful without yodl but the installation was not,
which was not really a surprise.  However, after installing yodl, the
installation still failed.  Even after doing a make clean or make
distclean, and reconfiguring.  That's not a very intuitive behavior.  

If those empty files are going to be created, I would suggest, when it
checks if they are empty, if yodl is installed, then automatically
delete and re-build them.  

You might also consider, if yodl is not installed, rather than exiting
with an error, perhaps printing a message to stderr that they are being
skipped and why, then continuing without error.  If you prefer it to
exit with an error by default in this case, then perhaps print a message
providing an alternate installation target that can be used to install
without the man pages.

Vince