rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-25 22:08:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Clarify config options use

Browse Source 
Update #3836.
This commit is contained in:
Sebastian Huber 2020-04-01 08:58:01 +02:00
parent 6f0bc56893
commit 39ca06c492
3 changed files with 34 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
c-user/config/general.rst
View File

@ -375,9 +375,12 @@ DESCRIPTION:
NOTES: NOTES:
If there are more processors available than configured, the rest will be If there are more processors available than configured, the rest will be
ignored. In uniprocessor configuration, this configuration define is
ignored. 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.
.. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE .. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
.. index:: maximum thread name size .. index:: maximum thread name size

24
c-user/config/mpci.rst
View File

@ -36,8 +36,10 @@ DESCRIPTION:
options are assumed to be provided. options are assumed to be provided.
NOTES: NOTES:
This has no impact unless RTEMS was built with the This configuration option shall be undefined if the multiprocessing support
``--enable-multiprocessing`` build configuration option. is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
build configuration option). Otherwise a compile time error in the
configuration file will occur.
.. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK .. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
@ -73,7 +75,8 @@ DESCRIPTION:
:ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
NOTES: NOTES:
None. This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
@ -103,6 +106,9 @@ NOTES:
This value corresponds to the total number of objects which can be created This value corresponds to the total number of objects which can be created
with the ``RTEMS_GLOBAL`` attribute. with the ``RTEMS_GLOBAL`` attribute.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. index:: CONFIGURE_MP_MAXIMUM_NODES .. index:: CONFIGURE_MP_MAXIMUM_NODES
.. _CONFIGURE_MP_MAXIMUM_NODES: .. _CONFIGURE_MP_MAXIMUM_NODES:
@ -128,7 +134,8 @@ DESCRIPTION:
a multiprocessor system. a multiprocessor system.
NOTES: NOTES:
None. This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. index:: CONFIGURE_MP_MAXIMUM_PROXIES .. index:: CONFIGURE_MP_MAXIMUM_PROXIES
@ -161,6 +168,9 @@ NOTES:
remote tasks/threads which can be blocked on objects on this node, see remote tasks/threads which can be blocked on objects on this node, see
:ref:`MPCIProxies`. :ref:`MPCIProxies`.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
.. _CONFIGURE_MP_MPCI_TABLE_POINTER: .. _CONFIGURE_MP_MPCI_TABLE_POINTER:
@ -190,6 +200,9 @@ NOTES:
Multiprocessor System assuming the BSP provides the proper set of Multiprocessor System assuming the BSP provides the proper set of
supporting methods. supporting methods.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. index:: CONFIGURE_MP_NODE_NUMBER .. index:: CONFIGURE_MP_NODE_NUMBER
.. _CONFIGURE_MP_NODE_NUMBER: .. _CONFIGURE_MP_NODE_NUMBER:
@ -219,3 +232,6 @@ NOTES:
the Makefile variable ``NODE_NUMBER``. The same code is compiled with the the Makefile variable ``NODE_NUMBER``. The same code is compiled with the
``NODE_NUMBER`` set to different values. The test programs behave ``NODE_NUMBER`` set to different values. The test programs behave
differently based upon their node number. differently based upon their node number.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.

10
c-user/config/posix-api.rst
View File

@ -176,6 +176,11 @@ VALUE CONSTRAINTS:
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type ``uintptr_t``.
* It shall be zero if the POSIX API is not
enabled (e.g. RTEMS was built without the ``--enable-posix`` build
configuration option). Otherwise a compile time error in the configuration
file will occur.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX The value of this configuration option defines the maximum number of POSIX
API Queued Signals that can be concurrently active. API Queued Signals that can be concurrently active.
@ -366,6 +371,11 @@ VALUE CONSTRAINTS:
object class, if the value passed to :c:func:`rtems_resource_unlimited` object class, if the value passed to :c:func:`rtems_resource_unlimited`
satisfies all other constraints of this configuration option. satisfies all other constraints of this configuration option.
* It shall be zero if the POSIX API is not
enabled (e.g. RTEMS was built without the ``--enable-posix`` build
configuration option). Otherwise a compile time error in the configuration
file will occur.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX The value of this configuration option defines the maximum number of POSIX
API Timers that can be concurrently active. API Timers that can be concurrently active.