summaryrefslogtreecommitdiffstats
path: root/eng
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-01-03 11:28:36 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-01-07 07:19:50 +0100
commitb44feffacb0903e889d3a15913aa365f0317604e (patch)
tree5fe69998cb71a72fa27702001d24c1afe77d1981 /eng
parent1fdd3cf83d154af66ad0edf5094d93075063c7e0 (diff)
downloadrtems-docs-b44feffacb0903e889d3a15913aa365f0317604e.tar.bz2
eng: Rework preface and add mission statement
Add mission statement based on the wiki page: https://devel.rtems.org/wiki/Mission_Statement Do format changes and some rewording.
Diffstat (limited to 'eng')
-rw-r--r--eng/index.rst1
-rw-r--r--eng/license-requirements.rst1
-rw-r--r--eng/mission.rst75
-rw-r--r--eng/preface.rst29
4 files changed, 83 insertions, 23 deletions
diff --git a/eng/index.rst b/eng/index.rst
index cfc831b..74bdec5 100644
--- a/eng/index.rst
+++ b/eng/index.rst
@@ -24,6 +24,7 @@ RTEMS Software Engineering (|version|)
:numbered:
preface
+ mission
prequalification
stakeholders
management
diff --git a/eng/license-requirements.rst b/eng/license-requirements.rst
index 39ef722..44814b1 100644
--- a/eng/license-requirements.rst
+++ b/eng/license-requirements.rst
@@ -3,6 +3,7 @@
.. Copyright (C) 2018.
.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+.. _LicensingRequirements:
Licensing Requirements
**********************
diff --git a/eng/mission.rst b/eng/mission.rst
new file mode 100644
index 0000000..e1b0ec5
--- /dev/null
+++ b/eng/mission.rst
@@ -0,0 +1,75 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C) 2020 embedded brains GmbH
+.. Copyright (C) 2015 Chris Johns
+.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+
+RTEMS Project Mission Statement
+*******************************
+
+RTEMS development done under the umbrella of the RTEMS Project aims to provide a
+free and open real-time operating system targeted towards deeply embedded
+systems which is competitive with proprietary products. The RTEMS Project
+encourages the support and use of standard APIs in order to promote application
+portability and ease porting other packages to the RTEMS environment.
+
+The RTEMS development effort uses an open development environment in which all
+users collaborate to improve RTEMS. The RTEMS cross development tool suite is
+based upon the free GNU tools and the open source standard C library newlib.
+RTEMS supports many host platforms and target architectures.
+
+Free Software Project
+=====================
+
+The free software goals of the project are:
+
+* RTEMS and supporting components are available under various free licenses with
+ copyrights being held by individual authors.
+
+* All software which executes on the target will not place undue restrictions on
+ embedded applications. See also :ref:`LicensingRequirements`.
+
+* Patches must be legally acceptable for inclusion into the RTEMS Project or the
+ specific project being used.
+
+Design and Development Goals
+============================
+
+* Source based development with all users building from source
+
+* Any suitable host should be supported
+
+* Open testing, tests and test results
+
+* Ports to new architectures and CPU models
+
+* Addition of Board Support Packages for available hardware
+
+* Improved runtime libraries
+
+* Faster debug cycle
+
+* Various other infrastructure improvements
+
+Open Development Environment
+============================
+
+* Encourage cooperation and communication between developers
+
+* Work more closely with "consumers"
+
+* Code available to everyone at any time, and everyone is welcome to participate
+ in development
+
+* Patches will be considered equally based on their technical merits
+
+* All individuals and companies are welcome to contribute as long as they accept
+ the ground rules
+
+* Open mailing lists
+
+* Developer friendly tools and procedures with a focus on keeping them current
+
+* Conflicts of interest exist for many RTEMS developers. The developers
+ contributing to the RTEMS Project must put the interests of the RTEMS Project
+ first.
diff --git a/eng/preface.rst b/eng/preface.rst
index 1e49aa7..593745c 100644
--- a/eng/preface.rst
+++ b/eng/preface.rst
@@ -1,29 +1,12 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2018.
-.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+.. Copyright (C) 2020 embedded brains GmbH
Preface
*******
-The Real Time Executive for Multiprocessor Systems (RTEMS) operating
-systems is a layered system with each of the public APIs implemented in
-terms of a common foundation layer called the SuperCore. RTEMS provides
-full capabilities for management of tasks, interrupts time, and multiple
-processors in addition to those features typical of generic operating
-systems. RTEMS has been implemented in both the Ada and C programming
-languages.
-
-.. topic: RTEMS Mission Statement
-
- RTEMS development aims to provide a free deterministic real-time operating
- system targeted towards deeply embedded systems which is competitive
- with closed source products. The RTEMS project encourages the support
- and use of standard APIs in order to promote application portability
- and ease porting other packages to the RTEMS environment. Source:
- https://devel.rtems.org/wiki/Mission_Statement
-
-The RTEMS development effort uses an open development environment in
-which all users collaborate to improve RTEMS. The RTEMS cross development
-toolset is based upon the free GNU tools and the open source C Library
-newlib. RTEMS supports many host platforms and target architectures.
+This manual aims to guide the development of RTEMS itself. You should read this
+document if you want to participate in the development of RTEMS. Users of RTEMS
+may find background information in this manual. Please refer to the
+:r:url:`user` and :r:url:`c-user` if you want to know how the RTEMS development
+environment is set up and how you can develop applications using RTEMS.