path: root/develenv/introduction.rst
diff options
authorAmar Takhar <>2016-01-16 14:53:40 -0500
committerAmar Takhar <>2016-05-02 20:51:22 -0400
commitc0d6eff67d896dbe0b73761d5dd9d59bd71ddfcd (patch)
treeca8641db1455b3727e843316373a93a5b84bb573 /develenv/introduction.rst
parent11d2a74dae0f7d9a7de64fca43b19f92b3f9a5c0 (diff)
Split document.
Diffstat (limited to 'develenv/introduction.rst')
1 files changed, 53 insertions, 0 deletions
diff --git a/develenv/introduction.rst b/develenv/introduction.rst
new file mode 100644
index 0000000..b3cb391
--- /dev/null
+++ b/develenv/introduction.rst
@@ -0,0 +1,53 @@
+This document describes the RTEMS development
+environment. Discussions are provided for the following topics:
+- the directory structure used by RTEMS,
+- usage of the GNU Make utility within the RTEMS
+ development environment,
+- sample applications, and
+- the RTEMS specific utilities.
+RTEMS was designed as a reusable software component.
+Highly reusable software such as RTEMS is typically distributed
+in the form of source code without providing any support tools.
+RTEMS is the foundation for a complex family of facilities
+including board support packages, device drivers, and support
+libraries. The RTEMS Development Environment is not a CASE
+tool. It is a collection of tools designed to reduce the
+complexity of using and enhancing the RTEMS family. Tools are
+provided which aid in the management of the development,
+maintenance, and usage of RTEMS, its run-time support
+facilities, and applications which utilize the executive.
+A key component of the RTEMS development environment
+is the GNU family of free tools. This is robust set of
+development and POSIX compatible tools for which source code is
+freely available. The primary compilers, assemblers, linkers,
+and make utility used by the RTEMS development team are the GNU
+tools. They are highly portable supporting a wide variety of
+host computers and, in the case of the development tools, a wide
+variety of target processors.
+It is recommended that the RTEMS developer become
+familiar with the RTEMS Development Environment before
+proceeding with any modifications to the executive source tree.
+The source code for the executive is very modular and source
+code is divided amongst directories based upon functionality as
+well as dependencies on CPU and target board. This organization
+is aimed at isolating and minimizing non-portable code. This
+has the immediate result that adding support for a new CPU or
+target board requires very little "wandering" around the source
+.. COMMENT: COPYRIGHT (c) 1989-2010.
+.. COMMENT: On-Line Applications Research Corporation (OAR).
+.. COMMENT: All rights reserved.