[PATCH rtems-docs] c-user: Update references to --enable-* configure options.
Joel Sherrill
joel at rtems.org
Fri May 20 13:46:48 UTC 2022
Also updated list of SMP architectures and added enough lead in
to let users know the source code was the definitive answer.
---
c-user/config/general.rst | 6 +++---
c-user/config/mpci.rst | 17 ++++++++--------
c-user/config/posix-api.rst | 28 +++++++++++++++------------
c-user/symmetric_multiprocessing_services.rst | 23 +++++++++++++++-------
4 files changed, 44 insertions(+), 30 deletions(-)
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index a1f242a..0da7530 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -437,9 +437,9 @@ Each processor needs an IDLE task stack and interrupt stack for example.
If there are more processors available than configured, the rest will be
ignored.
-This configuration option is only evaluated in SMP configurations (e.g. RTEMS
-was built with the ``--enable-smp`` build configuration option). In all
-other configurations it has no effect.
+This configuration option is only evaluated in SMP configurations of RTEMS
+(e.g. RTEMS was built with the SMP build configuration option enabled).
+In all other configurations it has no effect.
.. rubric:: CONSTRAINTS:
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index 09c541f..d40f15c 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -23,12 +23,13 @@
Multiprocessing Configuration
=============================
-This section describes multiprocessing related configuration options. The
-options are only used if RTEMS was built with the ``--enable-multiprocessing``
-build configuration option. Additionally, this class of configuration options
-are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
-is defined. The multiprocessing (MPCI) support must not be confused with the
-SMP support.
+This section describes multiprocessing related configuration options.
+The options are only used if RTEMS was built when the multiprocessing
+build configuration option is enabled. The multiprocessing configuration
+is distinct from the SMP configuration. Additionally, this class of
+configuration options are only applicable if the configuration option
+:ref:`CONFIGURE_MP_APPLICATION` is defined. The multiprocessing (MPCI)
+support must not be confused with the SMP support.
.. Generated from spec:/acfg/if/mp-extra-server-stack
@@ -115,8 +116,8 @@ options are assumed to be provided.
.. rubric:: NOTES:
This configuration option shall be undefined if the multiprocessing support
-is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
-build configuration option). Otherwise a compile time error in the
+is not enabled (e.g. RTEMS was built without the multiprocessing build
+configuration option enabled). Otherwise a compile time error in the
configuration file will occur.
.. Generated from spec:/acfg/if/mp-max-global-objects
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index 12e6410..78cb724 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -25,7 +25,7 @@ POSIX API Configuration
This section describes configuration options related to the POSIX API. Most
POSIX API objects are available by default since RTEMS 5.1. The queued signals
-and timers are only available if RTEMS was built with the ``--enable-posix``
+and timers are only available if RTEMS was built with the enable POSIX
build configuration option.
.. Generated from spec:/acfg/if/max-posix-keys
@@ -231,8 +231,8 @@ API Queued Signals that can be concurrently active.
Unlimited objects are not available for queued signals.
-Queued signals are only available if RTEMS was built with the
-``--enable-posix`` build configuration option.
+Queued signals are only available if RTEMS was built with the POSIX API
+build configuration option enabled.
.. rubric:: CONSTRAINTS:
@@ -470,29 +470,33 @@ API Timers that can be concurrently active.
This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.
-Timers are only available if RTEMS was built with the
-``--enable-posix`` build configuration option.
+Timers are only available if RTEMS was built with the POSIX API build
+configuration option enabled.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
-* The value of the configuration option shall be greater than or equal to zero.
+* The value of the configuration option shall be greater than or equal
+to zero.
-* The value of the configuration option shall be less than or equal to 65535.
+* The value of the configuration option shall be less than or equal
+to 65535.
* The value of the configuration option shall be less than or equal to a
- BSP-specific and application-specific value which depends on the size of the
- memory available to the application.
+ BSP-specific and application-specific value which depends on the size
+ of the memory available to the application.
* The value of the configuration option may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for the
object class, if the value passed to :c:func:`rtems_resource_unlimited`
satisfies all other constraints of the configuration option.
-* The value of the configuration option shall be zero if the POSIX API is not
- enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` build
- configuration option). Otherwise a compile time error in the configuration
+* The value of the configuration option shall be zero if the POSIX API
+is not
+ enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True``
+ build configuration option). Otherwise a compile time error in the
+ configuration
file will occur.
.. Generated from spec:/acfg/if/min-posix-thread-stack-size
diff --git a/c-user/symmetric_multiprocessing_services.rst b/c-user/symmetric_multiprocessing_services.rst
index acfee56..89dc48c 100644
--- a/c-user/symmetric_multiprocessing_services.rst
+++ b/c-user/symmetric_multiprocessing_services.rst
@@ -13,10 +13,19 @@ Symmetric Multiprocessing (SMP)
Introduction
============
-The Symmetric Multiprocessing (SMP) support of the RTEMS is available on
+RTEMS Symmetric Multiprocessing (SMP) support is available on a subset
+of target architectures supported by RTEMS. Further on some target
+architectures, it is only available on a subset of BSPs. The user is
+advised to check the BSP specific documentation and RTEMS source code
+to verify the status of SMP support for a specific BSP. The following
+architectures have support for SMP:
+
+-- AArch64
- ARMv7-A,
+- i386,
+
- PowerPC,
- RISC-V, and
@@ -25,8 +34,8 @@ The Symmetric Multiprocessing (SMP) support of the RTEMS is available on
.. warning::
- The SMP support is only available if RTEMS was built with the
- ``--enable-smp`` build configuration option.
+ SMP support is only available if RTEMS was built with the
+ SMP build configuration option enabled.
RTEMS is supposed to be a real-time operating system. What does this mean in
the context of SMP? The RTEMS interpretation of real-time on SMP is the
@@ -580,10 +589,10 @@ Profiling
---------
To identify the bottlenecks in the system, support for profiling of low-level
-synchronization is optionally available. The profiling support is a BSP build
-time configuration option (``--enable-profiling``) and is implemented with an
-acceptable overhead, even for production systems. A low-overhead counter for
-short time intervals must be provided by the hardware.
+synchronization is optionally available. The profiling support is
+an RTEMS build time configuration option and is implemented with an
+acceptable overhead, even for production systems. A low-overhead counter
+for short time intervals must be provided by the hardware.
Profiling reports are generated in XML for most test programs of the RTEMS
testsuite (more than 500 test programs). This gives a good sample set for
--
1.8.3.1
More information about the devel
mailing list