diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-01 08:58:01 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-02 09:46:01 +0200 |
| commit | 39ca06c4921ae713a5dfc2d16d419a1db55e0365 (patch) | |
| tree | 99b25d97d5750b6380a9ce90cbb7c9980c49e3ae /c-user/config/mpci.rst | |
| parent | eng: Add glossary terms (diff) | |
| download | rtems-docs-39ca06c4921ae713a5dfc2d16d419a1db55e0365.tar.bz2 | |
c-user: Clarify config options use
Update #3836.
Diffstat (limited to 'c-user/config/mpci.rst')
| -rw-r--r-- | c-user/config/mpci.rst | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst index a3b5e23..854600b 100644 --- a/c-user/config/mpci.rst +++ b/c-user/config/mpci.rst @@ -36,8 +36,10 @@ DESCRIPTION: options are assumed to be provided. NOTES: - This has no impact unless RTEMS was built with the - ``--enable-multiprocessing`` build configuration option. + 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 + configuration file will occur. .. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK @@ -73,7 +75,8 @@ DESCRIPTION: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. NOTES: - None. + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS @@ -103,6 +106,9 @@ NOTES: This value corresponds to the total number of objects which can be created with the ``RTEMS_GLOBAL`` attribute. + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. + .. index:: CONFIGURE_MP_MAXIMUM_NODES .. _CONFIGURE_MP_MAXIMUM_NODES: @@ -128,7 +134,8 @@ DESCRIPTION: a multiprocessor system. NOTES: - None. + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. .. index:: CONFIGURE_MP_MAXIMUM_PROXIES @@ -161,6 +168,9 @@ NOTES: remote tasks/threads which can be blocked on objects on this node, see :ref:`MPCIProxies`. + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. + .. index:: 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 supporting methods. + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. + .. index:: 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 ``NODE_NUMBER`` set to different values. The test programs behave differently based upon their node number. + + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. |