Changeset 2151927 in rtems-docs


Ignore:
Timestamp:
Mar 22, 2016, 2:42:02 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
c075916
Parents:
27bcdfb
git-author:
Chris Johns <chrisj@…> (03/22/16 02:42:02)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:27)
Message:

Corrections.

Location:
user/start
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • user/start/basics.rst

    r27bcdfb r2151927  
    2424version of RTEMS to exist on your host machine at a time. The ``autoconf`` and
    2525``automake`` tools required by RTEMS are not versioned and vary between RTEMS
    26 versions. If you use a single *prefix* then there is a chance things from
    27 different versions may interact. This should not happen but it could.
     26versions. If you use a single *prefix* there is a chance things from different
     27versions may interact. This should not happen but it could.
    2828
    2929For POSIX or Unix hosts the RTEMS Project uses :file:`/opt/rtems` as a standard
    3030*prefix*. We view this *prefix* as a production level path and we place
    3131development versions under a different *prefix* away from the production
    32 versions. Under this top level *prefix* we place the various versions, for
    33 example for version 4.11.0 the *prefix* would be :file:`/opt/rtems/4.11.0`. If
    34 an update called 4.11.1 is released the *prefix* would be
    35 :file:`/opt/rtems/4.11.1`. This choice is entirly yours. You may decide to have
    36 a single path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
     32versions. Under this top level *prefix* we place the various versions we need
     33for development, for example the version 4.11.0 the *prefix* would be
     34:file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the *prefix*
     35would be :file:`/opt/rtems/4.11.1`. These are recommendations and the choice of
     36what you use is entirly yours. You may decide to have a single path for all
     37RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
    3738
    38 For Windows a typical prefix is :file:`C:\\opt` and as an MSYS2 path that is
     39For Windows a typical prefix is :file:`C:\\opt` and as an MSYS2 path this is
    3940:file:`/c/opt`.
    4041
     
    4849project and under that prefix you create a simple yet repeatable structure.
    4950
    50 As an exapmle lets say I have a large disk under :file:`/bd` for *Big Disk*. As
    51 ``root`` create a directory called ``project`` and give the directory suitable
    52 permissions to be writable by you as a user.
     51As an exapmle lets say I have a large disk mounted under :file:`/bd` for *Big
     52Disk*. As ``root`` create a directory called ``projects`` and give the
     53directory suitable permissions to be writable by you as a user.
    5354
    54 Lets create project sandbox for my *Box Sorter* project. First create a project
    55 directory called :file:`/bd/projects/box-sorter`. Under this create
     55Lets create a project sandbox for my *Box Sorter* project. First create a
     56project directory called :file:`/bd/projects/box-sorter`. Under this create
    5657:file:`rtems` and under that create :file:`rtems-4.11.0`. Under this path you
    5758can follow the :ref:`released-version` procedure to build a tool set using the
     
    6061
    6162A variation of this is to have a single set of *production* tools and RTEMS
    62 BSPs on the disk under :file:`/bd/rtems` you can share between your projects.
     63BSPs on the disk under :file:`/bd/rtems` you can share between your
     64projects. The top level directories would be:
    6365
    6466:file:`/bd/rtems`
     
    7274  Project specific development trees.
    7375
    74 A further variation is to use the ``--without-rtems`` option with the RTEMS to
     76:file:`/bd/projects/box-sorter`
     77  Box Sorter project sandbox.
     78
     79A further variation is to use the ``--without-rtems`` option with the RSB to
    7580not build the BSPs when building the tools and to buld RTEMS specifically for
    76 each project. This lets you have a production tools installed at a top level
    77 on your disk and each project can have a specific and possibly customised
    78 version of RTEMS.
     81each project. This lets you have a production tools installed at a top level on
     82your disk and each project can have a specific and possibly customised version
     83of RTEMS. The top level directories would be:
    7984
    8085:file:`/bd/rtems`
     
    8994:file:`/bd/projects`
    9095  Project specific development trees.
     96
     97:file:`/bd/projects/box-sorter`
     98  Box Sorter project sandbox.
     99
     100:file:`/bd/projects/box-sorter/rtems`
     101  Box Sorter project's custom RTEMS kernel source and installed BSP.
    91102
    92103If there is an RTEMS kernel you to share between projects you can move this to
     
    108119  Project specific development trees.
    109120
     121:file:`/bd/projects/box-sorter`
     122  Box Sorter project sandbox.
     123
    110124The project sandoxing approach allows you move a specific production part into
    111125the project's sandbox to allow you to customise it. This is useful if you are
     
    114128build the kernel with them. Release notes with each release will let know
    115129what you need to update.
     130
     131If the machine is a central project development machine simply replace
     132:file:`projects` with :file:`users` and give each user a personal directory.
  • user/start/depend.rst

    r27bcdfb r2151927  
    1616and it is not a distrbution. Providing binary packages for every possible host
    1717operating system is to big a task for the RTEMS Project and it is not a good
    18 use of the core developers time. Their time is better spent making RTEMS better
    19 and faster.
     18use of the core developer's time. Their time is better spent making RTEMS
     19better and faster.
    2020
    2121Developer Computer
     
    3838do not 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
    40 built all your time can be spent writing and developing your application.
     40built all your time can be spent writing and developing your application. Over
     41an hour does happen and for the ARM architecture with all BSPs it can be many
     42hours.
    4143
    4244Host Software
     
    7476and a desktop machine to a team with decentralised or centralised development
    7577infrastructure. The RTEMS project provides you with the development tools and
    76 aids to help you create an environment that matches the project's needs. You
    77 need to decide on the languages used in your project, which version control
    78 system, and the build system for your application. The RTEMS Project's aims to
    79 give complete freedom to decide what you use.
     78aids to help you create an environment that matches your project's needs. The
     79RTEMS Project's aims to give complete freedom to decide on the languages used
     80in your project, which version control system, and the build system for your
     81application.
    8082
    8183The following are a few ways you can set up a suitable environment. You are not
     
    99101assigned to users.
    100102
    101 If you have ``root`` you can decide to install the tools under any suitable
    102 prefix. This may depend on the hardware in your host development machine. If
    103 the machine is a centralised build server the prefix may be used to separate
    104 production versions from the test versions and as just discussed the prefix
    105 paths may have restricted access to only those who manage the configuration
    106 control of the machine.
     103If you have ``root`` access you can decide to install the tools under any
     104suitable prefix. This may depend on the hardware in your host development
     105machine. If the machine is a centralised build server the prefix may be used to
     106separate production versions from the test versions and as just discussed the
     107prefix paths may have restricted access to only those who manage and
     108configuration control of the machine.
    107109
    108110Apple OS X
    109111----------
    110112
    111 Apple's OS X is fully supported. You to download and install a recent version
    112 of the free Apple developers application Xcode. Xocde is available in the App
     113Apple's OS X is fully supported. You need to download and install a recent
     114version of the Apple developer application Xcode. Xocde is available in the App
    113115Store. Make sure you install the Command Line Tools add on available for
    114116download within Xcode and once installed open a Terminal shell and enter the
     
    164166characters. This can effect some of the tools used by RTEMS. It is recommended
    165167you keep the top level directories as short as possible when building the RTEMS
    166 tools and you also keep an eye on the path length when developing your
     168tools and you should also keep an eye on the path length when developing your
    167169application. The RTEMS built tools can handle much longer path lengths however
    168170some of the GNU tools such as those in the ``binutils`` package cannot. The
    169 release packages of the RSB are too big to build RTEMS so you need to change
    170 that path to build.
     171release packages of the RSB when unpacked has a top level file names that is
     172too big to build RTEMS so you need to change that path to something smaller to
     173build. This is indicated in :ref:`released-version`.
     174
     175.. _msys2_parallel_builds:
     176
     177Parallel Builds with Make
     178~~~~~~~~~~~~~~~~~~~~~~~~~
    171179
    172180The MSYS2 GNU ``make`` has problems when using the `jobs` option. The RSB
  • user/start/releases.rst

    r27bcdfb r2151927  
    4040RTEMS FTP the RSB will fall back to the packages home site.
    4141
    42 .. note:: **Control the RTEMS Kernel Build**
     42.. note:: **Controlling the RTEMS Kernel Build**
    4343
    4444   The RTEMS kernel is built by default for releases. To not build the RTEMS
     
    109109and test the samples RTEMS builds by default
    110110
    111 If building on Windows add ``--jobs=none`` to avoid GNU make issues on Windows.
     111If building on Windows add ``--jobs=none`` to avoid GNU make issues on Windows
     112discussed in :ref:`msys2_parallel_builds`.
    112113
    113114.. code-block:: shell
Note: See TracChangeset for help on using the changeset viewer.