Changeset a34c157 in rtems-docs


Ignore:
Timestamp:
Mar 23, 2016, 10:33:29 PM (3 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
aae09e2
Parents:
6958370
git-author:
Chris Johns <chrisj@…> (03/23/16 22:33:29)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:27)
Message:

Corrections from Worth Burruss. Many thanks.

Location:
user
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • user/glossary/index.rst

    r6958370 ra34c157  
    1 ========
     1
     2.. _glossary:
     3
    24Glossary
    35========
     
    57.. glossary::
    68
    7         Waf
    8                 Waf build system.  For more information see http://www.waf.io/
     9  Binutils
     10    GNU Binary Utilities such as the assembler ``as``, linker ``ld`` and a
     11    range of other tools used in the development of software.
    912
    10         Test Suite
    11         Testsuite
    12                 RTEMS test suite located in the ``testsuites/`` directory.
     13  DLL
     14    Dynamically Linker Library used on Windows.
    1315
     16  GCC
     17    GNU Compiler Tool chain. It is the GNU C/C++ compiler, binutils and GDB.
    1418
    15         RTEMS
    16                 The Real-Time Executive for Multiprocessor Systems or RTEMS is a open source fully featured Real Time Operating System or RTOS that supports a variety of open standard application programming interfaces (API) and interface standards such as POSIX and BSD sockets.
     19  GDB
     20    GNU Debugger
     21
     22  MinGW
     23    Minimal GNU system for Windows that lets GCC built programs use the
     24    standard Windows operating system DLLs. It lets you build native Windows
     25    programs with the GNU GCC compiler.
     26
     27  MinGW64
     28    Minimal GNU system for 64bit Windows. MinGW64 is not the MinGW project.
     29
     30  MSYS2
     31    Minimal System 2 is a fork of the MinGW project's MSYS tool and the MinGW
     32    MSYS tool is a fork of Cygwin project. The Cygwin project provides a POSIX
     33    emulation layer for Windows so POSIX software can run on Windows. MSYS is a
     34    minimal version that is just enough to let ``configure`` scripts run. MSYS
     35    has a simplied path structure to make it easier to building native Windows
     36    programs.
     37
     38  POSIX
     39    Portable Operating System Interface is a standard that lets software be
     40    portable between compliant operating systems.
     41
     42  prefix
     43    A path used when building a package so all parts of the package reside
     44    under that path.
     45
     46  RSB
     47    RTEMS Source Builder is part of the RTEMS Tools Project. It builds packages
     48    such as the tools for the RTEMS operating system.
     49
     50  RTEMS
     51    The Real-Time Executive for Multiprocessor Systems or RTEMS is a open
     52    source fully featured Real Time Operating System or RTOS that supports a
     53    variety of open standard application programming interfaces (API) and
     54    interface standards such as POSIX and BSD sockets.
     55
     56  Test Suite
     57   See Testsuite
     58
     59  Testsuite
     60    RTEMS test suite located in the ``testsuites/`` directory.
     61
     62  Waf
     63    Waf build system.  For more information see http://www.waf.io/
  • user/overview/index.rst

    r6958370 ra34c157  
    1 =========
     1
     2.. _overview:
     3
    24Overview
    35=========
     
    3537- high level of user configurability
    3638
    37 RTEMS provides features found in moderen operating system:
     39RTEMS provides features found in modern operating systems:
    3840
    3941- file systems
     
    4345- USB
    4446
    45 - perminante media such as flash disks, cards and USB devices
     47- permanent media such as flash disks, cards and USB devices
    4648
    4749Real-time Application Systems
  • user/start/basics.rst

    r6958370 ra34c157  
    22.. comment: All rights reserved.
    33
    4 .. _prefixs:
     4.. _prefixes:
    55
    66Prefixes
    77========
    88
    9 You will see the term **prefix** referred to though out this documentation and
     9You will see the term **prefix** referred to thoughout this documentation and
    1010in a wide number of software packages you can download from the internet. A
    1111**prefix** is a path on your computer a software package is built and installed
     
    4646
    4747Project specific sandboxes let you have a number of projects running in
    48 parallel with each project in its own sandbox. You simlpy have a prefix per
     48parallel with each project in its own sandbox. You simply have a prefix per
    4949project and under that prefix you create a simple yet repeatable structure.
    5050
    51 As an exapmle lets say I have a large disk mounted under :file:`/bd` for *Big
     51As an example lets say I have a large disk mounted under :file:`/bd` for *Big
    5252Disk*. As ``root`` create a directory called ``projects`` and give the
    5353directory suitable permissions to be writable by you as a user.
  • user/start/depend.rst

    r6958370 ra34c157  
    2727projects have a suitable development machine per developer while others set up
    2828a tightly controlled central build server. RTEMS is flexible and lets you
    29 engineering a development environment that suites you. The basic specs are:
     29engineer a development environment that suites you. The basic specs are:
    3030
    3131- Multicore processor
     
    3535RTEMS makes no demands on graphics.
    3636
    37 If you are using a VM or your host computer that is not a fast current machine
    38 do not be concerned. The tools may take longer to build than faster hardware
     37If you are using a VM or your host computer and is not a fast modern machine do
     38not be concerned. The tools may take longer to build than faster hardware
    3939however building tools is something you do once. Once the tools and RTEMS is
    4040built all your time can be spent writing and developing your application. Over
     
    5555- Solaris
    5656
    57 The functionality on POSIX operating such as Linux and FreeBSD is similar and
    58 most features on Windows are supported but you are best to ask on
     57The functionality on a POSIX operating such as Linux and FreeBSD is similar and
     58most features on Windows are supported but you are best to ask on the
    5959:r:list:`users` if you have a specific question.
    6060
    61 Install and set up your host operating system. We recommend you maintain your
    62 operating system by installing any updates.
     61We recommend you maintain your operating system by installing any updates.
    6362
    6463POSIX Hosts
     
    7776infrastructure. The RTEMS project provides you with the development tools and
    7877aids to help you create an environment that matches your project's needs. The
    79 RTEMS Project's aims to give complete freedom to decide on the languages used
    80 in your project, which version control system, and the build system for your
    81 application.
     78RTEMS Project's aim is to give you complete freedom to decide on the languages
     79used in your project, which version control system, and the build system for
     80your application.
    8281
    8382The following are a few ways you can set up a suitable environment. You are not
     
    8685following set ups assume suitable disk space and disk performance.
    8786
    88 Adminisrator Access
    89 ~~~~~~~~~~~~~~~~~~~
     87Administrator Access
     88~~~~~~~~~~~~~~~~~~~~
    9089
    9190You either have ``root`` access to your host development machine or you do
     
    9796
    9897RTEMS Tools and packages do not require ``root`` access
    99 to be built and we encourage you do not build the tools as ``root``. If you
     98to be built and we encourage you to not build the tools as ``root``. If you
    10099need to control write access then it is best to manage this with groups
    101100assigned to users.
     
    105104machine. If the machine is a centralised build server the prefix may be used to
    106105separate production versions from the test versions and as just discussed the
    107 prefix paths may have restricted access to only those who manage and
    108 configuration control of the machine.
     106prefix paths may have restricted access rights to only those who manage and
     107have configuration control of the machine.
    109108
    110109Apple OS X
     
    144143source packages such as `gcc` so they form an important and valued part of the
    145144environment we describe here. The output of this procedure forms the tools you
    146 use during your application development and they do not depend the emulation
     145use during your application development and they do not depend on the emulation
    147146DLLs.
    148147
     
    170169tools and you should also keep an eye on the path length when developing your
    171170application. The RTEMS built tools can handle much longer path lengths however
    172 some of the GNU tools such as those in the ``binutils`` package cannot. The
    173 release packages of the RSB when unpacked has a top level file names that is
    174 too big to build RTEMS so you need to change that path to something smaller to
    175 build. This is indicated in :ref:`released-version`.
     171some of the GNU tools such as those in the ``binutils`` package cannot.
     172
     173The release packages of the RSB when unpacked have top level file names that
     174are too big to build RTEMS. You need to change or rname that path to something
     175smaller to build. This is indicated in :ref:`released-version`.
    176176
    177177.. _msys2_parallel_builds:
     
    199199scripts needed to build the RTEMS tools and the RTEMS kernel.
    200200
    201 MSYS2 is built around the ``pacman`` packing tool. This makes MSYS2 a
     201MSYS2 is built around the ``pacman`` packaging tool. This makes MSYS2 a
    202202distribution and that is a welcome feature on Windows. You get a powerful tool
    203203to manage your development environment on Windows.
  • user/start/development.rst

    r6958370 ra34c157  
    2121
    2222The following procedure assumes you have installed and configured your host
    23 operating. It also assumes you have installed any dependent packages needed
    24 when building the tools and the kernel.
     23operating system. It also assumes you have installed any dependent packages
     24needed when building the tools and the kernel.
    2525
    2626You need to select a location to build and install the RTEMS Tool chain and
     
    3333The location used to install the tools and kernel is called the `prefix`. It is
    3434best to have a `prefix` for each different version of RTEMS you are using. If
    35 you are using RTEMS 4.11 in production it is not a good to install a
     35you are using RTEMS 4.11 in production it is not a good idea to install a
    3636development version of 4.12 over the top. A separate `prefix` for each version
    3737avoids this.
     
    591591
    592592You can either email the patch to :r:list:`devel` with the following git
    593 command:
     593command, and it is `minus one` on the command line:
    594594
    595595.. code-block:: shell
  • user/start/index.rst

    r6958370 ra34c157  
    66===============
    77
    8 RTEMS is an open source operating and an open source project. As a user you
    9 have access to all the source code and this `Getting Started`_ section will show
    10 you how you build the RTEMS compiler tools, kernel and 3rd party libraries from
    11 source.
     8RTEMS is an open source real-time operating system. As a user you have access
     9to all the source code and this `Getting Started`_ section will show you how
     10you build the RTEMS compiler tools, kernel and 3rd party libraries from source.
    1211
    1312.. include:: basics.rst
  • user/start/releases.rst

    r6958370 ra34c157  
    3232`prefix`. :ref:`prefixes` explains prefixes and how to use them. It is best to
    3333have a `prefix` for each different version of RTEMS you are using. If you are
    34 using RTEMS 4.11 in production it is not a good to install a development
    35 version of 4.12 over the top. A separate `prefix` for each version avoids this.
    36 
    37 Releases download all source packages from the RTEMS FTP server. Hosting all
    38 the source on the RTEMS FTP server ensures the source is present for the like
    39 of the release on the RTEMS FTP server. If there is a problem accessing the
    40 RTEMS FTP the RSB will fall back to the packages home site.
     34using RTEMS 4.11 in production it is **not** a good idea to install a
     35development version of 4.12 over the top by using the same `prefix` as the 4.11
     36build. A separate `prefix` for each version avoids this.
     37
     38Released versions of the RSB download all source code for all packages from the
     39:r:url:`ftp` rather than from the package's home site. Hosting all the source
     40on the :r:url:`ftp` ensures the source is present for the life of the
     41release on the :r:url:`ftp`. If there is a problem accessing the RTEMS FTP
     42the RSB will fall back to the packages home site.
     43
     44The :r:url:`ftp` is hosted at the Oregon State University's The Open Source Lab
     45(http://osuosl.org/). This is a nonprofit organization working for the
     46advancement of open source technologies and RTEMS is very fortunate to hosted
     47here. It has excellent internet access and performance.
    4148
    4249.. note:: **Controlling the RTEMS Kernel Build**
     
    5158   speed the build time up for some architectures that have a lot of BSPs.
    5259
    53 This procedure will build a SPARC tool chain.
    54 
    5560RTEMS Tools Chain
    5661-----------------
    5762
    58 Set up a suitable workspace to build the release in. On Unix:
     63This procedure will build a SPARC tool chain. Set up a suitable workspace to
     64build the release in. On Unix:
    5965
    6066.. code-block:: shell
  • user/start/windows.rst

    r6958370 ra34c157  
    8484
    8585To build a set of RTEMS tools for the Intel ``i386`` architecture. The build
    86 runs a single job rather a job per CPU in your machine and will take a long
    87 time so please be patient. The RSB creates a log file containing all the build
    88 output and it will be changing size. The RSB command to build ``i386`` tools
    89 is:
     86runs a single job rather than a job per CPU in your machine and will take a
     87long time so please be patient. The RSB creates a log file containing all the
     88build output and it will be changing size. The RSB command to build ``i386``
     89tools is:
    9090
    9191.. code-block:: shell
     
    324324We will build the RTEMS kernel for the ``i386`` target and the ``pc686``
    325325BSP. You can check the available BSPs by running the ``rtems-bsps`` command
    326 found in the to directory of the RTEMS kernel source. We build the Board
     326found in the top directory of the RTEMS kernel source. We build the Board
    327327Support Package (BSP) outside the kernel source tree:
    328328
     
    469469~~~~~~~~~~~~~~~~~~~
    470470
    471 The RTEMS BSD Library or libBSD as it is also know is a package of FreeBSD code
     471The RTEMS BSD Library or libBSD as it is also known is a package of FreeBSD code
    472472ported to RTEMS. It provides a number of advantanced services including a
    473 networking stack
     473networking stack.
     474
     475| This needs to move to a new section and be completed.
  • user/support/index.rst

    r6958370 ra34c157  
    1 =======
     1
     2.. _support:
     3
    24Support
    35=======
     
    57RTEMS offers a variety of support options.
    68
    7 This chapter covers all options available to both users and developers.  If you belive this is a bug report please submit it to the bug tracker otherwise the developers mailing list the default location.
     9This chapter covers all options available to both users and developers.  If you
     10believe this is a bug report please submit it to the bug tracker otherwise the
     11developers mailing list the default location.
    812
    913
     
    1317The bug tracker can be found at the :r:url:`bugs`.
    1418
    15 See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for details on submitting a ticket.
     19See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for
     20details on submitting a ticket.
    1621
    17 Be sure to do a cursory search for any tickets that may be relevant to your problem.
     22Be sure to do a cursory search for any tickets that may be relevant to your
     23problem.
    1824
    19 If you are unsure about your issue status submit a ticket and we will help you sort it out.
    20 
    21 
     25If you are unsure about your issue status submit a ticket and we will help you
     26sort it out.
    2227
    2328Documentation
    2429=============
    2530
    26 The latest user documentation can always be found at the :r:url:`docs`. 
     31The latest user documentation can always be found at the :r:url:`docs`.
    2732
    2833
     
    5762===
    5863
    59 RTEMS IRC is available on the Freenode network. See the `Freenode <http://www.freenode.net/>`_ web site for details on connecting, selecting a nickname, and general usage tips. If you are new to IRC it is recommended reading.
    60 
     64RTEMS IRC is available on the Freenode network. See the `Freenode
     65<http://www.freenode.net/>`_ web site for details on connecting, selecting a
     66nickname, and general usage tips. If you are new to IRC it is recommended
     67reading.
    6168
    6269These are the current IRC channels.
     
    6471  **#rtems**
    6572
    66 This is a general channel for all things RTEMS. You can just hang out with other RTEMS users and developers to talk about RTEMS, using RTEMS or to make contact with other RTEMS users.
    67 Logs
     73This is a general channel for all things RTEMS. You can just hang out with
     74other RTEMS users and developers to talk about RTEMS, using RTEMS or to make
     75contact with other RTEMS users.
    6876
    69 
    70 The #rtems channel is logged. You can find the logs at http://www.rtems.org/irclogs/. You can search the logs using Google by adding
     77The ``#rtems`` channel is logged. You can find the logs at
     78http://www.rtems.org/irclogs/. You can search the logs using Google by adding:
    7179
    7280  **site:rtems.org inurl:irclogs**
    7381
    74 to your search terms.
    75 
    76 
     82to your search terms.
    7783
    7884Developers
    7985==========
    8086
    81 Developers can find help and support on the mailing lists, see :ref:`support-mailing-lists`.
     87Developers can find help and support on the mailing lists, see
     88:ref:`support-mailing-lists`.
    8289
    83 Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be found on the :r:url:`devel`.
     90Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be
     91found on the :r:url:`devel`.
Note: See TracChangeset for help on using the changeset viewer.