Commit Graph

7 Commits

Author SHA1 Message Date
Joel Sherrill
1750364c21 Reformatted ASCII slightly to avoid line wrap. 2000-05-28 19:36:00 +00:00
Joel Sherrill
2ba8875a0b Patch rtemsdoc-4.5.0-rc-0.diff from Ralf Corsepius <corsepiu@faw.uni-ulm.de>
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.
2000-04-26 18:02:26 +00:00
Joel Sherrill
154f0a3744 Now includes figures. 1999-10-07 18:16:13 +00:00
Joel Sherrill
dbba80a9fb Enabled PCI register figure and renamed them to avoid _ in name to avoid
tool problems.
1999-10-06 16:38:02 +00:00
Joel Sherrill
936ae5dd1f Added DEC21140 document from Emmanuel Raguet <raguet@crf.canon.fr>. 1999-04-08 16:19:21 +00:00
Joel Sherrill
5dbc2e2e99 First attempt to build. 1999-04-08 16:09:11 +00:00
Joel Sherrill
56d4e48568 New file 1999-04-08 15:51:40 +00:00