summaryrefslogtreecommitdiffstats
path: root/c-user/config
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2022-05-20 08:45:16 -0500
committerJoel Sherrill <joel@rtems.org>2022-05-20 08:45:16 -0500
commit9ba26e7cb25e2bff2bd50871e2e7c9b477ee6f32 (patch)
treea20057322c1e0aeb7c06c08259001f4e77573dab /c-user/config
parentuser: Update architectures supporting TLS (diff)
downloadrtems-docs-9ba26e7cb25e2bff2bd50871e2e7c9b477ee6f32.tar.bz2
c-user: Update references to --enable-* configure options.
Also updated list of SMP architectures and added enough lead in to let users know the source code was the definitive answer.
Diffstat (limited to 'c-user/config')
-rw-r--r--c-user/config/general.rst6
-rw-r--r--c-user/config/mpci.rst17
-rw-r--r--c-user/config/posix-api.rst28
3 files changed, 28 insertions, 23 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