This directory contains the source code for all RTEMS documentation
in TexInfo format as well as utilities used in the generation
of the RTEMS documentation set. This source code is used to produce
the RTEMS documentation in various formats including PDF, HTML,
and PostScript.
${RTEMS_ROOT}/doc/FAQ/
This directory contains the source code for the RTEMS Frequently Asked Questions (FAQ) Collection.
${RTEMS_ROOT}/doc/user/
This directory contains the source code for the RTEMS Applications C User's Guide which documents the Classic API.
${RTEMS_ROOT}/doc/ada_user/
This directory contains the source code for the RTEMS Applications Ada User's Guide which documents the Ada95
binding to the Classic API. This manual is produced from
from the same source base as the RTEMS Application C User's Guide.
${RTEMS_ROOT}/doc/bsp_howto/
This directory contains the source code for the
RTEMS BSP and Device Driver Development Guide.
${RTEMS_ROOT}/doc/common/
This directory contains the source code for the files which
are shared across multiple manuals in the RTEMS Documentation Set.
This includes the copyright page as well as the timing
tables which can be filled in on a per BSP basis in the
CPU supplements.
${RTEMS_ROOT}/doc/develenv/
This directory contains the source code for the
RTEMS Development Environment Guide. This is
the document you are currently reading.
${RTEMS_ROOT}/doc/filesystem/
This directory contains the source code for the
RTEMS Filesystem Design Guide. This manual
is a continuous work in process as it attempts to
capture the design of the interface between system
calls and filesystem implementations as well as the
information required by those implementing filesystems.
${RTEMS_ROOT}/doc/gnu_docs/
This directory contains the scripts which assist in
generating HTML for the GNU tools in the RTEMS Cross
Development Environment set.
${RTEMS_ROOT}/doc/images/
This directory contains the source code for the graphics
used in the HTML version of the RTEMS Documentation.
${RTEMS_ROOT}/doc/itron3.0/
This directory contains the source code for the
RTEMS ITRON 3.0 API User's Guide.
${RTEMS_ROOT}/doc/networking/
This directory contains the source code for the
RTEMS Network Supplement.
${RTEMS_ROOT}/doc/new_chapters/
This directory contains the source code for the new documentation
components which have not yet been collected into a new manual or
merged into an existing document. Currently, this primarily
contains draft documentation for some portions of
the facilities implemented in ${RTEMS_ROOT}/c/src/libmisc/.
${RTEMS_ROOT}/doc/porting/
This directory contains the source code for the
RTEMS Porting Guide.
${RTEMS_ROOT}/doc/posix1003.1/
This directory contains the source code for the
RTEMS POSIX 1003.1 Compliance Guide.
${RTEMS_ROOT}/doc/posix_users/
This directory contains the source code for the
RTEMS POSIX API User's Guide. It is important to
note that RTEMS' support for POSIX is a combination of
functionality provided by RTEMS and the Newlib C Library
so some functionality is documented by Newlib.
${RTEMS_ROOT}/doc/relnotes/
This directory contains the source code for a formally
release notes document. This has not been used for
recent RTEMS releases.
${RTEMS_ROOT}/doc/rgdb_specs/
This directory contains the source code for the
RTEMS Remote Debugger Server Specifications.
${RTEMS_ROOT}/doc/rtems_gdb/
This directory contains the source code for the
RTEMS/GDB User's Guide.
${RTEMS_ROOT}/doc/started/
This directory contains the source code for the
Getting Started with RTEMS for C/C++ Users manual.
${RTEMS_ROOT}/doc/started_ada/
This directory contains the source code for the
Getting Started with RTEMS for Ada Users manual.
${RTEMS_ROOT}/doc/supplements/
This directory contains the source code for the various
RTEMS CPU Supplements.
the
${RTEMS_ROOT}/doc/tools/
This directory contains the source code for the tools
used on the development host to assist in producing the
RTEMS Documentation. The most important of these tools
is bmenu which generates the hierarchical node
linking commands based upon chapter, section, and
subsection organization.
RTEMS Development Environment Guide