[CLN-list] building documentation from CVS

Bruno Haible bruno at clisp.org
Tue Jan 15 12:18:47 CET 2008


Hello Alexei,

> Is there any way to build the documentation with standard tools?
> 
> doc/Makefile.in
> 
> 55 ${srcdir}/${PACKAGE}.texi : ${srcdir}/${PACKAGE}.tex
> 56         cp $< $@
> 57         ${EMACS} -batch $@ -load addnodes.el -f save-buffer
> 
> Or I really have to install that monster?

This rule of making is indeed outdated. At the time I wrote the doc,
"makeinfo" required @node lines in the form
  @node NODE, NEXT, PREV, TOP
and I did not want to spend time on this, so I used that little script
addnodes.el to generate these lines for me. Meanwhile it is also possible
to just write
  @node NODE
across all the file (*). This is much less of a hassle. Ypu still have to
update the @menu lines when adding a new section; but that's acceptable
burden. I'm therefore renaming cln.tex to cln.texi; this gets rid of the
need to have emacs installed.

Bruno

(*) makeinfo has a bug in its computation of Next and Prev links; therefore
I have to leave in 2 particular long @node lines.

2008-01-15  Bruno Haible  <bruno at clisp.org>

	* doc/cln.texi: Renamed from doc/cln.tex. Add @node lines and @menu
	lists.
	* doc/addnodes.el: Remove file.
	* doc/Makefile.in (${PACKAGE}.texi): Remove rule.
	(EMACS): Remove variable.
	(maintainer-clean): Don't remove ${PACKAGE}.texi.
	Reported by Alexei Sheplyakov <varg at theor.jinr.ru>.




More information about the CLN-list mailing list