doc/README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

#
#  $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.