[Lemon-devel] lemon-nodoc - missing doc/ files

[Alpár Jüttner]

Hi,

Thank you for pointing out this issue. I've created a ticket about it,
see https://lemon.cs.elte.hu/trac/lemon/ticket/432

> It just appears to be a tarball packaging issue, is this something
> that can be changed for future releases of LEMON?

Certainly. I'll soon fix the related Makefile.am files in the
development branch.

Moreover, CMAKE will replace autotool as the default build environment
starting from the upcoming major release. Thus, sooner or later all of
these problems will disappear, because the release tarball will
basically be a simple snapshot of the hg repository.

Best regards,
Alpar

P.S.: I'm pleased to see your effort for providing Debian LEMON
packages. Shouldn't we place a link to your packages here:
https://lemon.cs.elte.hu/trac/lemon/wiki/Downloads



On Fri, 2011-12-16 at 13:36 -0500, Jeffrey Wildman wrote:
> Hi,
> 
> The subject may sound silly, but some explanation will help.  The
> nodoc tarball (lemon-nodoc-1.2.3.tar.gz) is provided without pre-built
> documentation files, but I'd still like to build the documentation
> myself (for purposes of following up on packaging LEMON for
> Debian/Ubuntu [1,2,3]).  However, I'm experiencing some problems.
> 
> 
> Issue 1: doc/references.bib is missing from the tarball.  Without the
> file, I get errors regardless of which build system I use:
> 
> autotools: 'make html':
> >make[1]: *** No rule to make target `doc/references.bib', needed by `references.dox'.  Stop.
> >make[1]: Leaving directory `/home/wraith/Downloads/lemon-1.2.3'
> >make: *** [html-recursive] Error 1
> 
> cmake: 'make html':
> >Scanning dependencies of target html
> >Traceback (most recent call last):
> >  File "/home/wraith/Downloads/lemon-1.2.3/scripts/bib2dox.py", line 813, in <module>
> >    if __name__ == "__main__": main()
> >  File "/home/wraith/Downloads/lemon-1.2.3/scripts/bib2dox.py", line 811, in main
> >    filehandler(filepath)
> >  File "/home/wraith/Downloads/lemon-1.2.3/scripts/bib2dox.py", line 792, in filehandler
> >    washeddata = bibtexwasher(filecont_source)
> >UnboundLocalError: local variable 'filecont_source' referenced before assignment
> >make[3]: *** [doc/CMakeFiles/html] Error 1
> >make[2]: *** [doc/CMakeFiles/html.dir/all] Error 2
> >make[1]: *** [doc/CMakeFiles/html.dir/rule] Error 2
> >make: *** [html] Error 2
> 
> Solution: (Note: the file doc/references.bib isn't present in the
> tarball lemon-1.2.3.tar.gz either!)  I went to the main branch to find
> the file.  Once it is placed in the doc folder, running 'make html'
> finishes with either autotools or cmake.
> 
> 
> 
> Issue 2: doc/template.h is missing from the tarball and causes
> warnings after after running 'make html'.  From doc/doxygen.log:
> 
> autotools:
> >error: Tag file `/home/wraith/Downloads/lemon-1.2.3/doc/libstdc++.tag' does not exist or is not a file. Skipping it...
> >/home/wraith/Downloads/lemon-1.2.3/doc/dirs.dox:28: warning: No matching directory found for command \dir doc/
> >/home/wraith/Downloads/lemon-1.2.3/doc/coding_style.dox:122: warning: included file template.h is not found.  Check your EXAMPLE_PATH
> 
> cmake:
> >error: Tag file `/home/wraith/Downloads/lemon-1.2.3/build/doc/libstdc++.tag' does not exist or is not a file. Skipping it...
> >/home/wraith/Downloads/lemon-1.2.3/doc/dirs.dox:28: warning: No matching directory found for command \dir doc/
> >/home/wraith/Downloads/lemon-1.2.3/build/doc/mainpage.dox:20: warning: found more than one \mainpage comment block! Skipping this block.
> >/home/wraith/Downloads/lemon-1.2.3/doc/coding_style.dox:122: warning: included file template.h is not found. Check your EXAMPLE_PATH
> 
> Solution: Two of the relevant warnings are silenced by going to the
> main branch and copying template.h over to doc/ and rebuilding the
> documentation.
> 
> 
> FYI, I am downloading the tarballs from here:
> http://lemon.cs.elte.hu/pub/sources/
> ...and the files from here:
> http://lemon.cs.elte.hu/hg/lemon-main/file/9a716871028e/doc
> ...and I am running Ubuntu 11.10 Desktop 64-bit.
> 
> 
> It just appears to be a tarball packaging issue, is this something
> that can be changed for future releases of LEMON?
> 
> Regards,
> 
> -Jeff
> 
> [1] http://lemon.cs.elte.hu/pipermail/lemon-user/2010-March/000165.html
> [2] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=570930
> [3] http://mentors.debian.net/package/coinor-lemon
> _______________________________________________
> Lemon-devel mailing list
> Lemon-devel at lemon.cs.elte.hu
> http://lemon.cs.elte.hu/mailman/listinfo/lemon-devel
>