Files
rtems/doc
Joel Sherrill 39075eb2e1 2004-02-03 Joel Sherrill <joel@OARcorp.com>
* HELP.html, index.html.in, rtems_footer.html.in, rtems_header.html.in,
	FAQ/basic.t, gnu_docs/gnu_footer.html, gnu_docs/index.html,
	gnu_docs/refcard.html, gnu_docs/rtems_tools_index.html,
	started/binaries.t, started/buildc.t, started/buildrt.t,
	started/intro.t, started/require.t, started/sample.t,
	started/tversions.texi.in: Incorporating changes from pre-4.6.0
	review.
2004-02-04 00:34:09 +00:00
..
2004-01-17 15:53:35 +00:00
2000-05-08 19:44:25 +00:00

#
#  $Id$
#

Tools Required
==============
The following tools are used in the production of this documentation:

TeX
texinfo 4.0
texi2www-960103 (included in tree)

This was used by the authors to generate the directory tree figure
in the texinfo printed version:

tree (from the CTAN Archives -- see http://jasper.ora.com/ctan.html)

Changing the Version Number and Timestamp
=========================================

RTEMS Version number is in configure.in.  Edit that file and run bootstrap.

Documentation date is in common/setup.texi.in and also must be modified
by hand.  bootstrap does not have to be run after modifying this file.

Making the Documentation
========================

cd rtems-XXX/doc
../bootstrap
./configure --enable-maintainer-mode
cd tools ; make
cd ..
make info
make all
make install

Cleaning
========

make clean
make distclean
make maintainer-clean

Making a Source Distribution
============================
This generates a rtems-<version>.tar.gz in the toplevel directory.

Making a Preformatted Distribution
==================================
Install and tar it up. :)

Common Problems
===============

TeX pool_size too small.