path: root/porting/preface.rst
diff options
authorAmar Takhar <>2016-01-16 19:08:48 -0500
committerAmar Takhar <>2016-05-02 20:51:23 -0400
commit6733466adf26030f781c2779747472150238cadd (patch)
tree3d04d21658ddf18562cefa4d9c8f18dd1d6b4459 /porting/preface.rst
parent7526578599a75c155dd0a97243a2b2289268d836 (diff)
Split document into seperate files by section.
Diffstat (limited to 'porting/preface.rst')
1 files changed, 35 insertions, 0 deletions
diff --git a/porting/preface.rst b/porting/preface.rst
new file mode 100644
index 0000000..2567a56
--- /dev/null
+++ b/porting/preface.rst
@@ -0,0 +1,35 @@
+The purpose of this manual is to provide a roadmap to those people porting
+RTEMS to a new CPU family. This process includes a variety of activities
+including the following:
+- targeting the GNU development tools
+- porting the RTEMS executive code
+- developing a Board Support Package
+- writing an RTEMS CPU Supplement manual for the completed port.
+This document focuses on the process of actually porting the RTEMS
+executive code proper. Each of the data structures, routines, and macro
+definitions required of a port of RTEMS is described in this document.
+Porting any operating system, including RTEMS, requires knowledge of the
+operating system, target CPU architecture, and debug environment. It is
+very desirable to have a CPU simulator or hardware emulator when debugging
+the port. This manual assumes that the user is familiar with building and
+using RTEMS, the C programming language, and the target CPU architecture.
+It is desirable to be familiar with the assembly language for the target
+CPU family but since only a limited amount of assembly is required to port
+.. COMMENT: COPYRIGHT (c) 1988-2002.
+.. COMMENT: On-Line Applications Research Corporation (OAR).
+.. COMMENT: All rights reserved.