Changeset 89a33b3 in rtems-docs


Ignore:
Timestamp:
Jan 11, 2019, 12:54:10 PM (5 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
3de74ba
Parents:
c098290
git-author:
Sebastian Huber <sebastian.huber@…> (01/11/19 12:54:10)
git-committer:
Sebastian Huber <sebastian.huber@…> (01/14/19 06:15:27)
Message:

user: Move deployment details to RSB chapter

Location:
user
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • user/overview/index.rst

    rc098290 r89a33b3  
    266266provide packaging and deployment for a specific host environment, target
    267267architecture or BSP. The RTEMS Project encourages users and organizations to
    268 fill this role for the community.
    269 
    270 Building and Deploying Tool Binaries
    271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    272 
    273 If you wish to create and distribute your build or you want to archive a build
    274 you can create a tar file. We term this deploying a build. This is a more
    275 advanced method for binary packaging and installing of tools.
    276 
    277 By default the RTEMS Source Builder installs the built packages directly and
    278 optionally it can also create a *build set tar file* or a *package tar file*
    279 per package built. The normal and default behaviour is to let the RTEMS Source
    280 Builder install the tools. The source will be downloaded, built, installed and
    281 cleaned up.
    282 
    283 The tar files are created with the full build prefix present and if you follow
    284 the examples given in this documentation the path is absolute. This can cause
    285 problems if you are installing on a host you do not have super user or
    286 administrator rights on because the prefix path may references part you do not
    287 have write access too and tar will not extract the files. You can use the
    288 ``--strip-components`` option in tar if your host tar application supports it
    289 to remove the parts you do not have write access too or you may need to unpack
    290 the tar file somewhere and copy the file tree from the level you have write
    291 access from. Embedding the full prefix path in the tar files lets you know what
    292 the prefix is and is recommended. For example if
    293 ``/home/chris/development/rtems/4.11`` is the prefix used you cannot change
    294 directory to the root (``/``) and untar the file because the ``/home`` is root
    295 access only. To install a tar file you have downloaded into your new machine's
    296 ``Downloads`` directory in your home directoty you would enter:
    297 
    298 .. code-block:: shell
    299 
    300     $ cd /somewhere
    301     $ tar --strip-components=3 -xjf \
    302           $HOME/Downloads/rtems-4.11-sparc-rtems4.11-1.tar.bz2
    303 
    304 A build set tar file is created by adding ``--bset-tar-file`` option to the
    305 ``sb-set-builder`` command::
    306 
    307     $ ../source-builder/sb-set-builder --log=l-sparc.txt \
    308              --prefix=$HOME/development/rtems/4.11 \
    309              --bset-tar-file \     <1>
    310              4.11/rtems-sparc
    311     Source Builder - Set Builder, v0.2.0
    312     Build Set: 4.11/rtems-sparc
    313     config: expat-2.1.0-1.cfg
    314     package: expat-2.1.0-x86_64-freebsd9.1-1
    315     building: expat-2.1.0-x86_64-freebsd9.1-1
    316     config: tools/rtems-binutils-2.22-1.cfg
    317     package: sparc-rtems4.11-binutils-2.22-1
    318     building: sparc-rtems4.11-binutils-2.22-1
    319     config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
    320     package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    321     building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    322     config: tools/rtems-gdb-7.5.1-1.cfg
    323     package: sparc-rtems4.11-gdb-7.5.1-1
    324     building: sparc-rtems4.11-gdb-7.5.1-1
    325     installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11 <2>
    326     installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
    327     installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
    328     installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
    329     tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2      <3>
    330     cleaning: expat-2.1.0-x86_64-freebsd9.1-1
    331     cleaning: sparc-rtems4.11-binutils-2.22-1
    332     cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    333     cleaning: sparc-rtems4.11-gdb-7.5.1-1
    334     Build Set: Time 0:15:25.92873
    335 
    336 .. topic:: Items
    337 
    338   1. The option to create a build set tar file.
    339 
    340   2. The installation still happens unless you specify ``--no-install``.
    341 
    342   3. Creating the build set tar file.
    343 
    344 You can also suppress installing the files using the ``--no-install``
    345 option. This is useful if your prefix is not accessiable, for example when
    346 building Canadian cross compiled tool sets::
    347 
    348     $ ../source-builder/sb-set-builder --log=l-sparc.txt \
    349                 --prefix=$HOME/development/rtems/4.11 \
    350                 --bset-tar-file \
    351                 --no-install \      <1>
    352                 4.11/rtems-sparc
    353     Source Builder - Set Builder, v0.2.0
    354     Build Set: 4.11/rtems-sparc
    355     config: expat-2.1.0-1.cfg
    356     package: expat-2.1.0-x86_64-freebsd9.1-1
    357     building: expat-2.1.0-x86_64-freebsd9.1-1
    358     config: tools/rtems-binutils-2.22-1.cfg
    359     package: sparc-rtems4.11-binutils-2.22-1
    360     building: sparc-rtems4.11-binutils-2.22-1
    361     config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
    362     package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    363     building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    364     config: tools/rtems-gdb-7.5.1-1.cfg
    365     package: sparc-rtems4.11-gdb-7.5.1-1
    366     building: sparc-rtems4.11-gdb-7.5.1-1
    367     tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2    <2>
    368     cleaning: expat-2.1.0-x86_64-freebsd9.1-1
    369     cleaning: sparc-rtems4.11-binutils-2.22-1
    370     cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    371     cleaning: sparc-rtems4.11-gdb-7.5.1-1
    372     Build Set: Time 0:14:11.721274
    373     $ ls tar
    374     rtems-4.11-sparc-rtems4.11-1.tar.bz2
    375 
    376 .. topic:: Items
    377 
    378   1. The option to supressing installing the packages.
    379 
    380   2. Create the build set tar.
    381 
    382 A package tar file can be created by adding the ``--pkg-tar-files`` to the
    383 ``sb-set-builder`` command. This creates a tar file per package built in the
    384 build set::
    385 
    386     $ ../source-builder/sb-set-builder --log=l-sparc.txt \
    387             --prefix=$HOME/development/rtems/4.11 \
    388             --bset-tar-file \
    389             --pkg-tar-files \        <1>
    390             --no-install 4.11/rtems-sparc
    391     Source Builder - Set Builder, v0.2.0
    392     Build Set: 4.11/rtems-sparc
    393     config: expat-2.1.0-1.cfg
    394     package: expat-2.1.0-x86_64-freebsd9.1-1
    395     building: expat-2.1.0-x86_64-freebsd9.1-1
    396     config: tools/rtems-binutils-2.22-1.cfg
    397     package: sparc-rtems4.11-binutils-2.22-1
    398     building: sparc-rtems4.11-binutils-2.22-1
    399     config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
    400     package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    401     building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    402     config: tools/rtems-gdb-7.5.1-1.cfg
    403     package: sparc-rtems4.11-gdb-7.5.1-1
    404     building: sparc-rtems4.11-gdb-7.5.1-1
    405     tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2
    406     cleaning: expat-2.1.0-x86_64-freebsd9.1-1
    407     cleaning: sparc-rtems4.11-binutils-2.22-1
    408     cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
    409     cleaning: sparc-rtems4.11-gdb-7.5.1-1
    410     Build Set: Time 0:14:37.658460
    411     $ ls tar
    412     expat-2.1.0-x86_64-freebsd9.1-1.tar.bz2           sparc-rtems4.11-binutils-2.22-1.tar.bz2
    413     sparc-rtems4.11-gdb-7.5.1-1.tar.bz2 <2>           rtems-4.11-sparc-rtems4.11-1.tar.bz2 <3>
    414     sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1.tar.bz2
    415 
    416 .. topic:: Items
    417 
    418   1. The option to create packages tar files.
    419 
    420   2. The GDB package tar file.
    421 
    422   3. The build set tar file. All the others in a single tar file.
     268fill this role for the community. The :ref:`RTEMS Source Builder <RSB>`
     269provides some aid to :ref:`build and deploy tool binaries <RSBDeployment>`.
    423270
    424271Support
  • user/rsb/index.rst

    rc098290 r89a33b3  
    44
    55.. highlight:: shell
     6
     7.. _RSB:
    68
    79RTEMS Source Builder
     
    9092    configuration
    9193    commands
     94    deployment
    9295    bug-reporting
    9396    history
Note: See TracChangeset for help on using the changeset viewer.