RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

2007-11-29 Glenn Humphrey <glenn.humphrey@OARcorp.com>

Browse Source 
* develenv/direct.t, develenv/sample.t: Corrected various errors in the
	documentation.
This commit is contained in:
Glenn Humphrey
2007-11-29 16:13:32 +00:00
parent b5273f01dd
commit fc121ce659
3 changed files with 208 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
doc/develenv/direct.t
View File

@@ -127,7 +127,7 @@ be discussed further in this document.
@item $@{RTEMS_ROOT@}/cpukit/
This directory is the root for all of the "multilib'able"
portions of RTEMS. This is a GNU way of saying the the
portions of RTEMS. This is a GNU way of saying the
contents of this directory can be compiled like the
C Library (@code{libc.a}) and the functionality is
neither CPU model nor BSP specific. The source code
@@ -151,14 +151,14 @@ most important parts are found in the @code{custom/}
subdirectory. Each ".cfg" file in this directory
is associated with a specific BSP and describes
the CPU model, compiler flags, and procedure to
a produce an executable for the target board.
produce an executable for the target board.
These files are described in detail in the
@b{RTEMS BSP and Device Driver Development Guide}
and will not be discussed further in this document.
@item $@{RTEMS_ROOT@}/testsuites/
This directory contains the test suites for the
various RTEMS APIs and support libraries. This
various RTEMS APIs and support libraries. The
contents of this directory are discussed in the
@ref{Directory Structure testsuites/ Test Suites} section.
@@ -197,13 +197,6 @@ is the root for the BSPs and the Ada Test Suites as well
as CPU model and BSP dependent libraries. The contents of
this directory are discussed in the
@ref{Directory Structure c/src/ Directory} section.
@item $@{RTEMS_ROOT@}/c/make/
This directory is used to generate the file @code{target.cfg}
which is installed as part of the Application Makefiles. This
file contains settings for various Makefile variables to
tailor them to the particular CPU model and BSP configured.
@end table
@c
@@ -215,9 +208,18 @@ As mentioned previously, this directory is logically
the root for the RTEMS components
which are CPU model or board dependent. The
following is a list of the subdirectories in this
directorie and a description of each.
directory and a description of each.
@table @code
@item $@{RTEMS_ROOT@}/c/src/aclocal/
This directory contains the custom M4 macros which are available to
the various GNU autoconf @code{configure.ac} scripts throughout
this portion of the RTEMS source tree. GNU autoconf interprets
@code{configure.ac} files to produce the @code{configure} files used
to tailor RTEMS build for a particular host and target environment. The
contents of this directory will not be discussed further in this
document.
@item $@{RTEMS_ROOT@}/c/src/ada/
This directory contains the Ada95 language bindings to the
RTEMS Classic API.
@@ -226,8 +228,13 @@ RTEMS Classic API.
This directory contains the test suite for the Ada
language bindings to the Classic API.
@item $@{RTEMS_ROOT@}/c/src/automake/
This directory contains files which are "Makefile fragments."
They are included as required by the various @code{Makefile.am}
files throughout this portion of the RTEMS source tree.
@item $@{RTEMS_ROOT@}/c/src/lib/
This directory contains the directories @code{libbsp}
This directory contains the directories @code{libbsp/}
and @code{libcpu/} which contain the source code for
the Board Support Packages (BSPs) and CPU Model
specific source code for RTEMS.
@@ -249,7 +256,7 @@ This directory contains device drivers for various
peripheral chips which are designed to be CPU and
board dependent. This directory contains a variety
of drivers for serial devices, network interface
controllers, and real-time clocks.
controllers, shared memory and real-time clocks.
@item $@{RTEMS_ROOT@}/c/src/librtems++/
This directory contains C++ classes which map to the RTEMS
@@ -261,6 +268,11 @@ rules files which are installed as part of the Application Makefiles.
This file contains settings for various Makefile variables to
tailor them to the particular CPU model and BSP configured.
@item $@{RTEMS_ROOT@}/c/src/nfsclient/
This directory contains a Network File System (NFS) client
for RTEMS. With this file system, a user's application can
access files on a remote computer.
@item $@{RTEMS_ROOT@}/c/src/optman/
This directory contains stubs for the RTEMS Classic API
Managers which are considered optional and whose use
@@ -268,6 +280,11 @@ may be explicitly forbidden by an application. All of the
directive implementations in this Optional Managers
return @code{E_NOTCONFIGURED}.
@item $@{RTEMS_ROOT@}/c/src/support/
This directory exists solely to generate the RTEMS
version string which includes the RTEMS version,
CPU architecture, CPU model, and BSP name.
@item $@{RTEMS_ROOT@}/c/src/wrapup/
This directory is responsible for taking the individual
libraries and objects built in each of the components
@@ -294,16 +311,12 @@ processor family.
The "libbsp" directory provides all the BSPs provided with this
release of the RTEMS executive. The subdirectories are
divided, as discussed previously, based on specific processor
family, then further breaking down into specific target board
environments. The "shmdr" subdirectory provides the
implementation of a shared memory driver which supports the
multiprocessing portion of the executive. In addition, two
starting point subdirectories are provided for reference. The
"no_cpu" subdirectory provides a template BSP which can be used
to develop a specific BSP for an unsupported target board. The
"stubdr" subdirectory provides stubbed out BSPs. These files
may aid in preliminary testing of the RTEMS development
environment that has been built for no particular target in mind.
family, then further broken down into specific target board
environments. The "no_cpu" subdirectory provides a starting point
template BSP which can be used to develop a specific BSP for an
unsupported target board. The files in this subdirectory may aid
in preliminary testing of the RTEMS development environment that has
been built for no particular target in mind.
Below each CPU dependent directory is a directory for each target BSP
supported in this release.
@@ -484,7 +497,7 @@ processors.
This directory contains the port of the Simple HTTPD
web server to RTEMS.
@item $@{RTEMS_ROOT@}/cpukit/telnet/
@item $@{RTEMS_ROOT@}/cpukit/telnetd/
This directory contains the RTEMS telnetd server.
@item $@{RTEMS_ROOT@}/cpukit/wrapup/
@@ -546,7 +559,7 @@ using the RTEMS executive. They are discussed in
This directory contains the test suite for the RTEMS
Classic API when executing on a single processor.
The tests were originally designed to provide
near complete test coverage for the the entire
near complete test coverage for the entire
executive code. With the addition of multiple APIs,
this is no longer the case as some SuperCore functionality
is not available through the Classic API. Thus
@@ -599,10 +612,6 @@ and PostScript.
@table @code
@item $@{RTEMS_ROOT@}/doc/user/
This directory contains the source code for the @cite{RTEMS
Applications C User's Guide} which documents the Classic API.
@item $@{RTEMS_ROOT@}/doc/ada_user/
This directory contains the source code for the @cite{RTEMS
Applications Ada User's Guide} which documents the Ada95
@@ -677,14 +686,6 @@ This directory contains the source code for a formally
release notes document. This has not been used for
recent RTEMS releases.
@item $@{RTEMS_ROOT@}/doc/rgdb_specs/
This directory contains the source code for the
@cite{RTEMS Remote Debugger Server Specifications}.
@item $@{RTEMS_ROOT@}/doc/rtems_gdb/
This directory contains the source code for the
@cite{RTEMS/GDB User's Guide}.
@item $@{RTEMS_ROOT@}/doc/started/
This directory contains the source code for the
@cite{Getting Started with RTEMS for C/C++ Users} manual.
@@ -701,4 +702,8 @@ is @code{bmenu} which generates the hierarchical node
linking commands based upon chapter, section, and
subsection organization.
@item $@{RTEMS_ROOT@}/doc/user/
This directory contains the source code for the @cite{RTEMS
Applications C User's Guide} which documents the Classic API.
@end table