summaryrefslogtreecommitdiffstats
path: root/user/overview/index.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-11 13:54:10 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-14 07:15:27 +0100
commit89a33b3db80521673bdd7c180f95b834e7f303d4 (patch)
tree833fd264d67e5e678355a9ce35e4ac69d232ecb8 /user/overview/index.rst
parentc0982900e96713381862b7c50da7ad892c80ff26 (diff)
downloadrtems-docs-89a33b3db80521673bdd7c180f95b834e7f303d4.tar.bz2
user: Move deployment details to RSB chapter
Diffstat (limited to 'user/overview/index.rst')
-rw-r--r--user/overview/index.rst157
1 files changed, 2 insertions, 155 deletions
diff --git a/user/overview/index.rst b/user/overview/index.rst
index f00ecdf..c3e0f71 100644
--- a/user/overview/index.rst
+++ b/user/overview/index.rst
@@ -265,161 +265,8 @@ The RTEMS Project provides the ecosystem as source code that users can download
to create personalised development environments. The RTEMS Project does not
provide packaging and deployment for a specific host environment, target
architecture or BSP. The RTEMS Project encourages users and organizations to
-fill this role for the community.
-
-Building and Deploying Tool Binaries
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you wish to create and distribute your build or you want to archive a build
-you can create a tar file. We term this deploying a build. This is a more
-advanced method for binary packaging and installing of tools.
-
-By default the RTEMS Source Builder installs the built packages directly and
-optionally it can also create a *build set tar file* or a *package tar file*
-per package built. The normal and default behaviour is to let the RTEMS Source
-Builder install the tools. The source will be downloaded, built, installed and
-cleaned up.
-
-The tar files are created with the full build prefix present and if you follow
-the examples given in this documentation the path is absolute. This can cause
-problems if you are installing on a host you do not have super user or
-administrator rights on because the prefix path may references part you do not
-have write access too and tar will not extract the files. You can use the
-``--strip-components`` option in tar if your host tar application supports it
-to remove the parts you do not have write access too or you may need to unpack
-the tar file somewhere and copy the file tree from the level you have write
-access from. Embedding the full prefix path in the tar files lets you know what
-the prefix is and is recommended. For example if
-``/home/chris/development/rtems/4.11`` is the prefix used you cannot change
-directory to the root (``/``) and untar the file because the ``/home`` is root
-access only. To install a tar file you have downloaded into your new machine's
-``Downloads`` directory in your home directoty you would enter:
-
-.. code-block:: shell
-
- $ cd /somewhere
- $ tar --strip-components=3 -xjf \
- $HOME/Downloads/rtems-4.11-sparc-rtems4.11-1.tar.bz2
-
-A build set tar file is created by adding ``--bset-tar-file`` option to the
-``sb-set-builder`` command::
-
- $ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file \ <1>
- 4.11/rtems-sparc
- Source Builder - Set Builder, v0.2.0
- Build Set: 4.11/rtems-sparc
- config: expat-2.1.0-1.cfg
- package: expat-2.1.0-x86_64-freebsd9.1-1
- building: expat-2.1.0-x86_64-freebsd9.1-1
- config: tools/rtems-binutils-2.22-1.cfg
- package: sparc-rtems4.11-binutils-2.22-1
- building: sparc-rtems4.11-binutils-2.22-1
- config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
- package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- config: tools/rtems-gdb-7.5.1-1.cfg
- package: sparc-rtems4.11-gdb-7.5.1-1
- building: sparc-rtems4.11-gdb-7.5.1-1
- installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11 <2>
- installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
- installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
- installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
- tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2 <3>
- cleaning: expat-2.1.0-x86_64-freebsd9.1-1
- cleaning: sparc-rtems4.11-binutils-2.22-1
- cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- cleaning: sparc-rtems4.11-gdb-7.5.1-1
- Build Set: Time 0:15:25.92873
-
-.. topic:: Items
-
- 1. The option to create a build set tar file.
-
- 2. The installation still happens unless you specify ``--no-install``.
-
- 3. Creating the build set tar file.
-
-You can also suppress installing the files using the ``--no-install``
-option. This is useful if your prefix is not accessiable, for example when
-building Canadian cross compiled tool sets::
-
- $ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file \
- --no-install \ <1>
- 4.11/rtems-sparc
- Source Builder - Set Builder, v0.2.0
- Build Set: 4.11/rtems-sparc
- config: expat-2.1.0-1.cfg
- package: expat-2.1.0-x86_64-freebsd9.1-1
- building: expat-2.1.0-x86_64-freebsd9.1-1
- config: tools/rtems-binutils-2.22-1.cfg
- package: sparc-rtems4.11-binutils-2.22-1
- building: sparc-rtems4.11-binutils-2.22-1
- config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
- package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- config: tools/rtems-gdb-7.5.1-1.cfg
- package: sparc-rtems4.11-gdb-7.5.1-1
- building: sparc-rtems4.11-gdb-7.5.1-1
- tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2 <2>
- cleaning: expat-2.1.0-x86_64-freebsd9.1-1
- cleaning: sparc-rtems4.11-binutils-2.22-1
- cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- cleaning: sparc-rtems4.11-gdb-7.5.1-1
- Build Set: Time 0:14:11.721274
- $ ls tar
- rtems-4.11-sparc-rtems4.11-1.tar.bz2
-
-.. topic:: Items
-
- 1. The option to supressing installing the packages.
-
- 2. Create the build set tar.
-
-A package tar file can be created by adding the ``--pkg-tar-files`` to the
-``sb-set-builder`` command. This creates a tar file per package built in the
-build set::
-
- $ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file \
- --pkg-tar-files \ <1>
- --no-install 4.11/rtems-sparc
- Source Builder - Set Builder, v0.2.0
- Build Set: 4.11/rtems-sparc
- config: expat-2.1.0-1.cfg
- package: expat-2.1.0-x86_64-freebsd9.1-1
- building: expat-2.1.0-x86_64-freebsd9.1-1
- config: tools/rtems-binutils-2.22-1.cfg
- package: sparc-rtems4.11-binutils-2.22-1
- building: sparc-rtems4.11-binutils-2.22-1
- config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
- package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- config: tools/rtems-gdb-7.5.1-1.cfg
- package: sparc-rtems4.11-gdb-7.5.1-1
- building: sparc-rtems4.11-gdb-7.5.1-1
- tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2
- cleaning: expat-2.1.0-x86_64-freebsd9.1-1
- cleaning: sparc-rtems4.11-binutils-2.22-1
- cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
- cleaning: sparc-rtems4.11-gdb-7.5.1-1
- Build Set: Time 0:14:37.658460
- $ ls tar
- expat-2.1.0-x86_64-freebsd9.1-1.tar.bz2 sparc-rtems4.11-binutils-2.22-1.tar.bz2
- sparc-rtems4.11-gdb-7.5.1-1.tar.bz2 <2> rtems-4.11-sparc-rtems4.11-1.tar.bz2 <3>
- sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1.tar.bz2
-
-.. topic:: Items
-
- 1. The option to create packages tar files.
-
- 2. The GDB package tar file.
-
- 3. The build set tar file. All the others in a single tar file.
+fill this role for the community. The :ref:`RTEMS Source Builder <RSB>`
+provides some aid to :ref:`build and deploy tool binaries <RSBDeployment>`.
Support
=======