Changeset ea0777e in rtems-docs


Ignore:
Timestamp:
Apr 1, 2016, 1:20:13 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
b412038
Parents:
aae09e2
git-author:
Chris Johns <chrisj@…> (04/01/16 01:20:13)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:27)
Message:

Review changes from Chris Mayfield.

Location:
user
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • user/overview/index.rst

    raae09e2 rea0777e  
    77Welcome to the :ref:term:`RTEMS` User Manual.
    88
    9 This document covers all the topic required as a user of RTEMS to use the RTEMS
    10 operating system.
     9This document covers all the topics required as a user of RTEMS to use the
     10RTEMS operating system.
    1111
    1212RTEMS, Real-Time Executive for Multiprocessor Systems, is a real-time executive
     
    1616.. sidebar:: Developers
    1717
    18   Developers should look at the :r:url:`devel` for technical information the
     18  Developers should look at the :r:url:`devel` for technical information. The
    1919  design and development of RTEMS is located there.
    2020
     
    6262Deadlines can be further characterized as either hard or soft based upon the
    6363value of the results when produced after the deadline has passed.  A deadline
    64 is hard if the results have no value or if their use will result in a
    65 catastrophic event.  In contrast, results which are produced after a soft
    66 deadline may have some value.
     64is hard if the results have no value after the deadline has passed, or a
     65catastophic event results from their intended use if not completed on time.  In
     66contrast, results produced after a soft deadline may still have some value.
    6767
    6868Another distinguishing requirement of real-time application systems is the
     
    8585===================
    8686
    87 Fortunately, real-time operating systems or real-time executives serve as a
     87Fortunately, real-time operating systems, or real-time executives, serve as a
    8888cornerstone on which to build the application system.  A real-time multitasking
    8989executive allows an application to be cast into a set of logical, autonomous
     
    100100application to demand-switch between tasks in response to real-time events.
    101101
    102 By proper grouping of responses to stimuli into separate tasks, a system can
    103 now asynchronously switch between independent streams of execution, directly
    104 responding to external stimuli as they occur.  This allows the system design to
    105 meet critical performance specifications which are typically measured by
    106 guaranteed response time and transaction throughput.  The multiprocessor
    107 extensions of RTEMS provide the features necessary to manage the extra
    108 requirements introduced by a system distributed across several processors.  It
    109 removes the physical barriers of processor boundaries from the world of the
    110 system designer, enabling more critical aspects of the system to receive the
    111 required attention. Such a system, based on an efficient real-time,
    112 multiprocessor executive, is a more realistic model of the outside world or
    113 environment for which it is designed.  As a result, the system will always be
    114 more logical, efficient, and reliable.
     102By properly grouping stimuli responses into separate tasks a system can now
     103asynchronously switch between independent streams of execution. This allows the
     104system to directly respond to external stimuli as they occur, as well as meet
     105critical performance specifications that are typically measured by guaranteed
     106response time and transaction throughput.  The multiprocessor extensions of
     107RTEMS provide the features necessary to manage the extra requirements
     108introduced by a system distributed across several processors.  It removes the
     109physical barriers of processor boundaries from the world of the system
     110designer, enabling more critical aspects of the system to receive the required
     111attention. Such a system, based on an efficient real-time, multiprocessor
     112executive, is a more realistic model of the outside world or environment for
     113which it is designed.  As a result, the system will always be more logical,
     114efficient, and reliable.
    115115
    116116By using the directives provided by RTEMS, the real-time applications developer
     
    125125===========
    126126
    127 RTEMS is an open source operating and an open source project. As a user you
    128 have access to all the source code and we encourage you to work with the source
    129 code and to integrate the processes used to build tools, the kernel and any 3rd
    130 party libraries into your project's configuration management processes. The
    131 RTEMS project is always improving the way it develivers the kernel to you and
    132 so your feedback is important.
     127RTEMS is an open source operating system and an open source project. As a user,
     128you have access to all the source code. We encourage you to work with the
     129source code and integrate the provided processes used to build tools, the
     130kernel and any 3rd party libraries into your project's configuration management
     131processes. The RTEMS project is always improving the way it develivers the
     132kernel to you and so your feedback is important.
    133133
    134134What we used in the RTEMS project to develop and maintain RTEMS does not
    135 dictate what you use to develop and maintain your project. You can and should
     135dictate what you use to develop and maintain your project. You can, and should,
    136136select the work-flow that best suites the demands of your project and what you
    137137are delivering.
  • user/start/basics.rst

    raae09e2 rea0777e  
    77========
    88
    9 You will see the term **prefix** referred to thoughout this documentation and
    10 in a wide number of software packages you can download from the internet. A
    11 **prefix** is a path on your computer a software package is built and installed
    12 under. Packages that have a **prefix** will place all parts under the *prefix
    13 path*. On a host computer like Linux the packages you install from your
    14 distribution typically use a platform specific standard *prefix*. For example
    15 on Linux it is :file:`/usr` and on FreeBSD it is :file:`/usr/local`.
     9You will see the term :ref:term:`prefix` referred to thoughout this
     10documentation and in a wide number of software packages you can download from
     11the internet. A **prefix** is the path on your computer a software package is
     12built and installed under. Packages that have a **prefix** will place all parts
     13under the **prefix** path. On a host computer like Linux the packages you
     14install from your distribution typically use a platform specific standard
     15**prefix**. For example on Linux it is :file:`/usr` and on FreeBSD it is
     16:file:`/usr/local`.
    1617
    17 We recommend you **do not** use the standard *prefix* when installing RTEMS
    18 Tools. If you are building the tools as a normal user and not as ``root`` the
    19 RTEMS Source Builder (RSB) will fail if the *prefix* is not writable. We
    20 recommend you leave the standand *prefix* for the packages your operating
    21 system installs.
     18We recommend you *DO NOT* use the standard **prefix** when installing the RTEMS
     19Tools. The standard **prefix** is the default **prefix** each package built by
     20the RSB contains. If you are building the tools when logged in as a *Standard
     21User* and not as the *Super User* (``root``) or *Administrator* the RTEMS
     22Source Builder (RSB) *will* fail and report an error if the default **prefix**
     23is not writable. We recommend you leave the standand **prefix** for the
     24packages your operating system installs or software you manually install such
     25as applications.
    2226
    23 A further reason not use the standard *prefix* is to allow more than one
     27A further reason not to use the standard **prefix** is to allow more than one
    2428version of RTEMS to exist on your host machine at a time. The ``autoconf`` and
    25 ``automake`` tools required by RTEMS are not versioned and vary between RTEMS
    26 versions. If you use a single *prefix* there is a chance things from different
    27 versions may interact. This should not happen but it could.
     29``automake`` tools required by RTEMS are not versioned and vary between the
     30various versions of RTEMS. If you use a single **prefix** such as the standard
     31**prefix** there is a chance parts from a package of different versions may
     32interact. This should not happen but it can.
    2833
    29 For POSIX or Unix hosts the RTEMS Project uses :file:`/opt/rtems` as a standard
    30 *prefix*. We view this *prefix* as a production level path and we place
    31 development versions under a different *prefix* away from the production
    32 versions. Under this top level *prefix* we place the various versions we need
    33 for development, for example the version 4.11.0 *prefix* would be
    34 :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the *prefix*
    35 would be :file:`/opt/rtems/4.11.1`. These are recommendations and the choice of
    36 what you use is entirly yours. You may decide to have a single path for all
    37 RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
     34For POSIX or Unix hosts, the RTEMS Project uses :file:`/opt/rtems` as it's
     35standard **prefix**. We view this **prefix** as a production level path, and we
     36prefer to place development versions under a different **prefix** away from the
     37production versions. Under this top level **prefix** we place the various
     38versions we need for development. For example the version 4.11.0 **prefix**
     39would be :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the
     40**prefix** would be :file:`/opt/rtems/4.11.1`. These are recommendations and
     41the choice of what you use is entirely yours. You may decide to have a single
     42path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
    3843
    39 For Windows a typical prefix is :file:`C:\\opt\\rtems` and as an MSYS2 path
     44For Windows a typical **prefix** is :file:`C:\\opt\\rtems` and as an MSYS2 path
    4045this is :file:`/c/opt/rtems`.
    4146
     
    4651
    4752Project specific sandboxes let you have a number of projects running in
    48 parallel with each project in its own sandbox. You simply have a prefix per
    49 project and under that prefix you create a simple yet repeatable structure.
     53parallel with each project in its own sandbox. You simply have a
     54:ref:term:`prefix` per project and under that prefix you create a simple yet
     55repeatable structure.
    5056
    5157As an example lets say I have a large disk mounted under :file:`/bd` for *Big
  • user/start/index.rst

    raae09e2 rea0777e  
    77
    88RTEMS is an open source real-time operating system. As a user you have access
    9 to all the source code and this `Getting Started`_ section will show you how
    10 you build the RTEMS compiler tools, kernel and 3rd party libraries from source.
     9to all the source code. This ``Getting Started`` section will show you how you
     10build the RTEMS compiler tools, kernel and 3rd party libraries from source.
    1111
    1212.. include:: basics.rst
Note: See TracChangeset for help on using the changeset viewer.