summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-11 15:28:57 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-14 07:15:27 +0100
commit0facb9de943c42f69b98ee4b1fcd115c20adafc0 (patch)
tree7db0b1764888560ba9fc886b8caf2a0c006520ac
parent3de74baacbb4145642d0e058846485bb4a3f631f (diff)
downloadrtems-docs-0facb9de943c42f69b98ee4b1fcd115c20adafc0.tar.bz2
user: Move "Prefixes" to "Quick Start"
Move "Project Sandboxing" to a separate section of the "Installation" chapter since this is an advance topic which may confuse new users.
-rw-r--r--user/installation/index.rst2
-rw-r--r--user/installation/project-sandboxing.rst (renamed from user/installation/prefixes-sandboxing.rst)41
-rw-r--r--user/start/index.rst9
-rw-r--r--user/start/prefixes.rst47
4 files changed, 57 insertions, 42 deletions
diff --git a/user/installation/index.rst b/user/installation/index.rst
index 07ccc68..1851bd4 100644
--- a/user/installation/index.rst
+++ b/user/installation/index.rst
@@ -45,7 +45,7 @@ repositories for the tools and kernel.
.. toctree::
- prefixes-sandboxing
releases
developer
kernel
+ project-sandboxing
diff --git a/user/installation/prefixes-sandboxing.rst b/user/installation/project-sandboxing.rst
index 0dd0589..2c5e508 100644
--- a/user/installation/prefixes-sandboxing.rst
+++ b/user/installation/project-sandboxing.rst
@@ -5,47 +5,6 @@
.. index:: Prefixes
.. _prefixes:
-Prefixes
-========
-
-You will see the term :ref:term:`prefix` referred to thoughout this
-documentation and in a wide number of software packages you can download from
-the internet. A **prefix** is the path on your computer a software package is
-built and installed under. Packages that have a **prefix** will place all parts
-under the **prefix** path. On a host computer like Linux the packages you
-install from your distribution typically use a platform specific standard
-**prefix**. For example on Linux it is :file:`/usr` and on FreeBSD it is
-:file:`/usr/local`.
-
-We recommend you *DO NOT* use the standard **prefix** when installing the RTEMS
-Tools. The standard **prefix** is the default **prefix** each package built by
-the RSB contains. If you are building the tools when logged in as a *Standard
-User* and not as the *Super User* (``root``) or *Administrator* the RTEMS
-Source Builder (RSB) *will* fail and report an error if the default **prefix**
-is not writable. We recommend you leave the standand **prefix** for the
-packages your operating system installs or software you manually install such
-as applications.
-
-A further reason not to use the standard **prefix** is to allow more than one
-version of RTEMS to exist on your host machine at a time. The ``autoconf`` and
-``automake`` tools required by RTEMS are not versioned and vary between the
-various versions of RTEMS. If you use a single **prefix** such as the standard
-**prefix** there is a chance parts from a package of different versions may
-interact. This should not happen but it can.
-
-For POSIX or Unix hosts, the RTEMS Project uses :file:`/opt/rtems` as it's
-standard **prefix**. We view this **prefix** as a production level path, and we
-prefer to place development versions under a different **prefix** away from the
-production versions. Under this top level **prefix** we place the various
-versions we need for development. For example the version 4.11.0 **prefix**
-would be :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the
-**prefix** would be :file:`/opt/rtems/4.11.1`. These are recommendations and
-the choice of what you use is entirely yours. You may decide to have a single
-path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
-
-For Windows a typical **prefix** is :file:`C:\\opt\\rtems` and as an MSYS2 path
-this is :file:`/c/opt/rtems`.
-
.. _project-sandboxing:
Project Sandboxing
diff --git a/user/start/index.rst b/user/start/index.rst
index 9bcd967..019817f 100644
--- a/user/start/index.rst
+++ b/user/start/index.rst
@@ -9,6 +9,15 @@
Quick Start
***********
+Follow the sections of this chapter step by step to get started developing
+applications on top of RTEMS.
+
+.. toctree::
+ :maxdepth: 5
+ :numbered:
+
+ prefixes
+
The following is a quick start guide that provides a basic set of commands to
build the RTEMS Tools and Kernel. The quick start guide provides links to the
detailed sections if any problems are encountered.
diff --git a/user/start/prefixes.rst b/user/start/prefixes.rst
new file mode 100644
index 0000000..e9dad29
--- /dev/null
+++ b/user/start/prefixes.rst
@@ -0,0 +1,47 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
+
+.. index:: prefix
+.. _prefixes:
+
+Prefixes
+========
+
+You will see the term :ref:term:`prefix` referred to thoughout this
+documentation and in a wide number of software packages you can download from
+the internet. A **prefix** is the path on your computer a software package is
+built and installed under. Packages that have a **prefix** will place all parts
+under the **prefix** path. On a host computer like Linux the packages you
+install from your distribution typically use a platform specific standard
+**prefix**. For example on Linux it is :file:`/usr` and on FreeBSD it is
+:file:`/usr/local`.
+
+We recommend you *DO NOT* use the standard **prefix** when installing the RTEMS
+Tools. The standard **prefix** is the default **prefix** each package built by
+the RSB contains. If you are building the tools when logged in as a *Standard
+User* and not as the *Super User* (``root``) or *Administrator* the RTEMS
+Source Builder (RSB) *will* fail and report an error if the default **prefix**
+is not writable. We recommend you leave the standand **prefix** for the
+packages your operating system installs or software you manually install such
+as applications.
+
+A further reason not to use the standard **prefix** is to allow more than one
+version of RTEMS to exist on your host machine at a time. The ``autoconf`` and
+``automake`` tools required by RTEMS are not versioned and vary between the
+various versions of RTEMS. If you use a single **prefix** such as the standard
+**prefix** there is a chance parts from a package of different versions may
+interact. This should not happen but it can.
+
+For POSIX or Unix hosts, the RTEMS Project uses :file:`/opt/rtems` as it's
+standard **prefix**. We view this **prefix** as a production level path, and we
+prefer to place development versions under a different **prefix** away from the
+production versions. Under this top level **prefix** we place the various
+versions we need for development. For example the version 4.11.0 **prefix**
+would be :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the
+**prefix** would be :file:`/opt/rtems/4.11.1`. These are recommendations and
+the choice of what you use is entirely yours. You may decide to have a single
+path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
+
+For Windows a typical **prefix** is :file:`C:\\opt\\rtems` and as an MSYS2 path
+this is :file:`/c/opt/rtems`.