Changeset dc234b5 in rtems-docs


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

Corrections from a review.

Location:
user/start
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • user/start/basics.rst

    rc075916 rdc234b5  
    3131development versions under a different *prefix* away from the production
    3232versions. Under this top level *prefix* we place the various versions we need
    33 for development, for example the version 4.11.0 the *prefix* would be
     33for development, for example the version 4.11.0 *prefix* would be
    3434:file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the *prefix*
    3535would be :file:`/opt/rtems/4.11.1`. These are recommendations and the choice of
     
    3737RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
    3838
    39 For Windows a typical prefix is :file:`C:\\opt` and as an MSYS2 path this is
    40 :file:`/c/opt`.
     39For Windows a typical prefix is :file:`C:\\opt\\rtems` and as an MSYS2 path
     40this is :file:`/c/opt/rtems`.
    4141
    4242.. _project_sandboxing:
     
    5858can follow the :ref:`released-version` procedure to build a tool set using the
    5959prefix of :file:`/bd/projects/box-sorter/rtems/4.11.0`. You are free to create
    60 your project specific directories under :file:`/bd/projects/box-sorter`.
    61 
    62 A variation of this is to have a single set of *production* tools and RTEMS
    63 BSPs on the disk under :file:`/bd/rtems` you can share between your
    64 projects. The top level directories would be:
    65 
    66 :file:`/bd/rtems`
    67   The top path to production tools and kernels.
    68 
    69 :file:`/bd/rtems/4.11.0`
    70   Production prefix for RTEMS 4.11.0 compiler, debuggers, tools and Board
    71   Support Packages (BSPs).
     60your project specific directories under :file:`/bd/projects/box-sorter`. The
     61top level directories would be:
    7262
    7363:file:`/bd/projects`
     
    7767  Box Sorter project sandbox.
    7868
    79 A further variation is to use the ``--without-rtems`` option with the RSB to
    80 not build the BSPs when building the tools and to buld RTEMS specifically for
    81 each project. This lets you have a production tools installed at a top level on
    82 your disk and each project can have a specific and possibly customised version
    83 of RTEMS. The top level directories would be:
     69:file:`/bd/projects/box-sorter/rtems/4.11.0`
     70  Project prefix for RTEMS 4.11.0 compiler, debuggers, tools and installed
     71  Board Support Package (BSP).
     72
     73A variation is to use the ``--without-rtems`` option with the RSB to not build
     74the BSPs when building the tools and to build RTEMS specifically for each
     75project. This lets you have a production tools installed at a top level on your
     76disk and each project can have a specific and possibly customised version of
     77RTEMS. The top level directories would be:
    8478
    8579:file:`/bd/rtems`
    86   The top path to production tools and kernels.
    87 
    88 :file:`/bd/rtems/4.11.0`
    89   Production prefix for RTEMS 4.11.0.
     80  The top path to production tools.
    9081
    9182:file:`/bd/rtems/4.11.0`
     
    10192  Box Sorter project's custom RTEMS kernel source and installed BSP.
    10293
    103 If there is an RTEMS kernel you to share between projects you can move this to
    104 a top level and share. In this case you will end up with:
     94A further varation if there is an RTEMS kernel you want to share between
     95projects is it to move this to a top level and share. In this case you will end
     96up with:
    10597
    10698:file:`/bd/rtems`
     
    122114  Box Sorter project sandbox.
    123115
     116Finally you can have a single set of *production* tools and RTEMS BSPs on the
     117disk under :file:`/bd/rtems` you can share between your projects. The top level
     118directories would be:
     119
     120:file:`/bd/rtems`
     121  The top path to production tools and kernels.
     122
     123:file:`/bd/rtems/4.11.0`
     124  Production prefix for RTEMS 4.11.0 compiler, debuggers, tools and Board
     125  Support Packages (BSPs).
     126
     127:file:`/bd/projects`
     128  Project specific development trees.
     129
     130:file:`/bd/projects/box-sorter`
     131  Box Sorter project sandbox.
     132
    124133The project sandoxing approach allows you move a specific production part into
    125134the project's sandbox to allow you to customise it. This is useful if you are
    126 testing new relesaes. The typical dependency is the order listed above. You can
     135testing new releases. The typical dependency is the order listed above. You can
    127136test new RTEMS kernels with production tools but new tools will require you
    128137build the kernel with them. Release notes with each release will let know
  • user/start/depend.rst

    rc075916 rdc234b5  
    1515it is, however this approach works well. RTEMS is not a host operating system
    1616and it is not a distrbution. Providing binary packages for every possible host
    17 operating system is to big a task for the RTEMS Project and it is not a good
    18 use of the core developer's time. Their time is better spent making RTEMS
    19 better and faster.
     17operating system is too big a task for the RTEMS Project and it is not a good
     18use of core developer time. Their time is better spent making RTEMS better and
     19faster.
    2020
    2121Developer Computer
     
    208208We need Python to build the tools as the RSB is written in Python and we need
    209209suitable Python libraries to link to GDB as RTEMS makes use of GDB's Python
    210 support. This place specific demands on the Python we need installed and
     210support. This places specific demands on the Python we need installed and
    211211available and MSYS2 provides suitable Python versions we can use. You need to
    212212make sure you have the correct type and version of Python installed.
     
    215215as they are built by Microsoft's C (MSC) compiler. Linking the MSC Python
    216216libraries with the MinGW64 executables is not easy and MSYS provided us with a
    217 simple solution so we do not support this.
    218 
    219 MSYS2 provides two types and versions of Python executables, MinGW and MSYS and
    220 Python version 2 and 3. For Windows we need the MinGW executable so we have
    221 suitables libraries and we have to have Python version 2 because on Windows GDB
    222 only builds with Python2.
    223 
    224 You also need to install the MSYS version of Python along with the MinGW64
    225 Python2 package. The MSYS Python is version 3 and the RSB can support version 2
    226 and 3 of Python and it helps handle some of the long paths building GCC can
    227 generate.
    228 
    229 Installing MSYS2
    230 ~~~~~~~~~~~~~~~~
    231 
    232 MSYS2 is installed on a new machine using the MSYS2 installer found on
    233 https://msys2.github.io/. Please select the ``x86_64`` variant for 64bit
    234 support. Run the installer followin the 7 steps listed on the page.
    235 
    236 MSYS2 uses the ``pacman`` package manager. The Arch Linux project has detailed
    237 documentation on how to use ``pacman``. What is shown here is a just few
    238 examples of what you can do.
    239 
    240 .. sidebar:: **Pin MSYS2 Shell to Taskbar**
    241 
    242   Pin the MSYS2 64bit Shell to the Taskbar so you always use it rather than
    243   the 32bit Shell.
    244 
    245 Open a 64bit MSYS shell from the Start Menu:
    246 
    247 .. figure:: msys2-minw64-start-menu.png
    248   :width: 50%
    249   :align: center
    250   :alt: MSYS2 64bit Shell Start Menu
    251 
    252 The packages we require are:
    253 
    254  * python
    255  * mingw-w64-x86_64-python2
    256  * mingw-w64-x86_64-gcc
    257  * git
    258  * bison
    259  * cvs
    260  * diffutils
    261  * make
    262  * patch
    263  * tar
    264  * texinfo
    265  * unzip
    266 
    267 .. note::
    268 
    269   The actual output provided may vary due to changes in the dependent packages
    270   or newer package versions.
    271 
    272 Install the packages using ``pacman``:
    273 
    274 .. code-block:: shell
    275 
    276   ~
    277   $ pacman -S python mingw-w64-x86_64-python2 mingw-w64-x86_64-gcc \
    278   >          bison cvs diffutils git make patch tar texinfo unzip
    279   resolving dependencies...
     217| simple solution so we do not support linking MSC libraries.
     218
     219| MSYS2 provides two types and versions of Python executables, MinGW and MSYS and
     220| Python version 2 and 3. For Windows we need the MinGW executable so we have
     221| suitables libraries and we have to have Python version 2 because on Windows GDB
     222| only builds with Python2.
     223
     224| You also need to install the MSYS version of Python along with the MinGW64
     225| Python2 package. The MSYS Python is version 3 and the RSB can support version 2
     226| and 3 of Python and it helps handle some of the long paths building GCC can
     227| generate.
     228
     229| Installing MSYS2
     230| ~~~~~~~~~~~~~~~~
     231
     232| MSYS2 is installed on a new machine using the MSYS2 installer found on
     233| https://msys2.github.io/. Please select the ``x86_64`` variant for 64bit
     234| support. Run the installer following the 7 steps listed on the page.
     235
     236| MSYS2 uses the ``pacman`` package manager. The Arch Linux project has detailed
     237| documentation on how to use ``pacman``. What is shown here is a just few
     238| examples of what you can do.
     239
     240| .. sidebar:: **Pin MSYS2 Shell to Taskbar**
     241
     242| Pin the MSYS2 64bit Shell to the Taskbar so you always use it rather than
     243| the 32bit Shell.
     244
     245| Open a 64bit MSYS shell from the Start Menu:
     246
     247| .. figure:: msys2-minw64-start-menu.png
     248| :width: 50%
     249| :align: center
     250| :alt: MSYS2 64bit Shell Start Menu
     251
     252| The packages we require are:
     253
     254| * python
     255| * mingw-w64-x86_64-python2
     256| * mingw-w64-x86_64-gcc
     257| * git
     258| * bison
     259| * cvs
     260| * diffutils
     261| * make
     262| * patch
     263| * tar
     264| * texinfo
     265| * unzip
     266
     267| .. note::
     268
     269| The actual output provided may vary due to changes in the dependent packages
     270| or newer package versions.
     271
     272| Install the packages using ``pacman``:
     273
     274| .. code-block:: shell
     275
     276| ~
     277| $ pacman -S python mingw-w64-x86_64-python2 mingw-w64-x86_64-gcc \
     278| bison cvs diffutils git make patch tar texinfo unzip
     279| resolving dependencies...
    280280  looking for conflicting packages...
    281281
  • user/start/releases.rst

    rc075916 rdc234b5  
    2626use a home directory, :ref:`development-version` has more details about
    2727this. If building on Windows use :file:`/c/opt/rtems` to keep the top level
    28 paths as sohrt as possible. :ref:`microsoft-windows-installation` provides more
     28paths as short as possible. :ref:`microsoft-windows-installation` provides more
    2929detail about path lengths on Windows.
    3030
    31 The location used to install the tools and kernel is called the `prefix`. It is
    32 best to have a `prefix` for each different version of RTEMS you are using. If
    33 you are using RTEMS 4.11 in production it is not a good to install a
    34 development version of 4.12 over the top. A separate `prefix` for each version
    35 avoids this.
     31The location used to install the tools and kernel is called the
     32`prefix`. :ref:`prefixes` explains prefixes and how to use them. It is best to
     33have a `prefix` for each different version of RTEMS you are using. If you are
     34using RTEMS 4.11 in production it is not a good to install a development
     35version of 4.12 over the top. A separate `prefix` for each version avoids this.
    3636
    3737Releases download all source packages from the RTEMS FTP server. Hosting all
     
    4242.. note:: **Controlling the RTEMS Kernel Build**
    4343
    44    The RTEMS kernel is built by default for releases. To not build the RTEMS
     44   Building releases by default builds the RTEMS kernel. To not build the RTEMS
    4545   kernel add the ``--without-rtems`` option to the RSB command line.
    4646
    4747   By default all the BSPs for an architecture are built. If you only wish to
    48    have a specific BSP build you can specify the BSP list by providing to the
     48   have a specific BSP built you can specify the BSP list by providing to the
    4949   RSB the option ``--with-rtemsbsp``. For example to build two BSPs for the
    50    SPARC architecture you can supply ``--with-rtemsbsp="erc32 sis"``.
     50   SPARC architecture you can supply ``--with-rtemsbsp="erc32 sis"``. This can
     51   speed the build time up for some architectures that have a lot of BSPs.
    5152
    5253This procedure will build a SPARC tool chain.
Note: See TracChangeset for help on using the changeset viewer.