Files
rtems/doc
Joel Sherrill e694c94bf7 2006-09-14 Joel Sherrill <joel@OARcorp.com>
* new_chapters/Makefile.am, new_chapters/gen_section,
	new_chapters/new_chapters.texi, user/Makefile.am, user/c_user.texi,
	user/dirstat.texi: Promote CPU Usage to first class citizen. Rename
	to start with rtems_ and include documentation in user guide.
	* user/cpuuse.t: New file.
	* new_chapters/cpuuse.t: Removed.
2006-09-14 15:06:38 +00:00
..
2004-03-09 09:13: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.