Ralf's comments follow:
Changes:
* Enhanced versioning:
- Addition of automake's version.texi support
- Replacement of rtemsdoc's former versioning support by automake's
versioning support (Abandoning RTEMS-UPDATE-* etc.)
- Abandoning setup.texi.in
- Add EDITION to each documents Makefile.am
- version.texi support in project.am
- Addition of maintainer mode (currently only used to prevent incorrectly
updating timestamps when users touch automake's version.texi timestamp
files (stamp-vti)).
* Fixing info dir support
- Use texinfo's @dircategory and @direntry instead of infos *-DIR-ENTRY
- $(infodir)/dir is now correctly set up
* Avoid using temporary files
- Pipe texts through REPLACE2 into BMENU2 instead of using temporary files.
- Abandon using bmenu in favor of bmenu2 (bmenu could be removed now)
* Prepare Makefile.ams for building in a separate buildtree
- prefix files with $(srcdir) in Makefile.am for files which must be
generated inside of the source tree
Notes:
* rtemsdoc can not yet be build in a separate source-tree, but we
are very close to it.
* You as the maintainer of this package now should always use
--enable-maintainer-mode to configure rtemsdoc.
which contains the bulk of converting the documentation tree to automake
and GNU conventions. Comments follow:
This is the automake port of rtemsdoc.
To apply:
cvs co rtemsdoc
cd rtemsdoc
sh cvs-rm.sh
patch -p0 < rtemsdoc-4.5.0-rc-0.diff
sh cvs-add.sh
[Attention: cvs-rm.sh and cvs-add.sh directly modify cvs]
Known bugs:
1) src2html is not supported (yet? - Is this supposed to work?)
2) all *.pdf images now are generated on-the-fly, but not yet deleted
during "make distclean"
3) All supplements, including the templated ones, get build and
installed.
4) Building outside of the source tree is completely untested and very
likely does not work.
5) Make [ps|pdf] are not (yet) supported, make [dvi|info] are supported
by automake's default texinfo rules.
Fixing 2, 3 and 5 is almost trivial and needs to be done.
4) is a matter of testing and tool-properties, for now it is simply
untested.
General issues:
* gif vs jpg vs png. I would recommend to replace all images with pngs
to avoid potential copyright issues (gif) or lack in quality (jpg, jpg
is good for real world photographs, but extremely poor on artificial
images, graphs).
* pdf images do net get placed correctly in pdf-documents.
* texinfo: We now use a local copy of texinfo-4.0's texinfo.tex in
texinfo/texinfo.tex for generating infos. However pdftex's system-wide
texinfo.tex and pdftexinfo.tex are used for generating *.dvi, *.ps, *.pdf.
* .cvsignore files still missing.
* I have renamed the supplements filename not to use c_<supplement>,
because automake seems to have problems with it.
Notes:
* Again, I recommend not to put any generated files into CVS. Here, this
comprises some *texi, all *.pdf and many *.html pages. Ie. I recommend
to run make maintainer-clean before checking in any files.
* To get building started, this should be sufficient:
./bootstrap
./configure
cd tools; make; cd ..
make info
* To make a public tarball:
[cvs co ; ./bootstrap]
./configure
cd tools; make; cd ..
make info
[make clean]
make dist
=> This generates a rtems-<version>.tar.gz in the toplevel directory.
=> Building the tools only is required after a "cvs co", but not in a
distribution tarball.
