Commit Graph

10 Commits

Author SHA1 Message Date
Joel Sherrill
adee597960 Numerous changes based on comments from Stephan Wilms <Stephan.Wilms@CWA.de>
including a new section in the Getting Started called "Where to
Go From Here", lots of index entries added, and more configuration
table information.
2000-05-04 19:45:17 +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
9f9efbca8d Adding information on prebuilt toolset binaries. 2000-02-22 17:48:01 +00:00
Joel Sherrill
0660b4f892 Changed copyright date to 1999. 1999-11-16 19:50:56 +00:00
Joel Sherrill
ed11cadf05 Numerous minor changes required to transition to the latest version
of texinfo and TeX.  This version of the tools can produce PDF with
figures included.
1999-10-01 17:44:06 +00:00
Joel Sherrill
79bb9221a7 Added Cygwin32 Chapter 1998-04-13 15:31:56 +00:00
Joel Sherrill
8a3fd66964 Printed copy given to Steve and Mark 1998-04-10 16:44:48 +00:00
Joel Sherrill
bdec27096a In texinfo nicely with all version dependent information
now in variables and some updates already in place.
1998-04-10 16:03:26 +00:00
Joel Sherrill
6113b3a63d Now builds clean for info, html, and ps. 1998-04-09 19:43:18 +00:00
Joel Sherrill
417fcc7375 base version 1998-04-09 19:18:04 +00:00