spec: Clarify config options use

11 files changed, 46 insertions, 5 deletions

diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-CONSTRAINTPOSIX.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-CONSTRAINTPOSIX.yml
new file mode 100644
index 00000000..7588b0a1
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-CONSTRAINTPOSIX.yml
@@ -0,0 +1,18 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+derived: false
+enabled-by: []
+header: ''
+level: 1.163
+links: []
+normative: true
+ref: ''
+reviewed: null
+text: |
+  The value of this configuration option 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.
+type: constraint
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
index 5bf40242..e4c5c1c6 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
@@ -15,6 +15,7 @@ appl-config-option-notes: |
 appl-config-option-constraint:
   min: 0
   links:
+  - RTEMS-ACFG-OPT-CONSTRAINTPOSIX
   - RTEMS-ACFG-OPT-CONSTRAINTWKSPACE
   - RTEMS-ACFG-OPT-CONSTRAINTMEMSZ
 copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
index 94bfa1da..4d550ddf 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
@@ -17,6 +17,7 @@ appl-config-option-constraint:
   min: 0
   max: 65535
   links:
+  - RTEMS-ACFG-OPT-CONSTRAINTPOSIX
   - RTEMS-ACFG-OPT-CONSTRAINTUNLIMITED
   - RTEMS-ACFG-OPT-CONSTRAINTMEMSZ
 copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml
index 7d8d4266..e0c32150 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml
@@ -12,8 +12,11 @@ appl-config-option-index: []
 appl-config-option-name: CONFIGURE_MAXIMUM_PROCESSORS
 appl-config-option-notes: |
   If there are more processors available than configured, the rest will be
-  ignored.  In uniprocessor configuration, this configuration define is
   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.
 appl-config-option-constraint:
   min: 0
   max: '``CPU_MAXIMUM_PROCESSORS``'
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml
index 598954c5..3ee6333e 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml
@@ -11,8 +11,10 @@ appl-config-option-description: |
 appl-config-option-index: []
 appl-config-option-name: CONFIGURE_MP_APPLICATION
 appl-config-option-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.
 copyrights:
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 derived: false
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml
index 02416bd4..c97dd89d 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml
@@ -7,7 +7,9 @@ appl-config-option-description: |
   :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
 appl-config-option-index: []
 appl-config-option-name: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
-appl-config-option-notes: null
+appl-config-option-notes: |
+  This configuration option is only evaluated if
+  :ref:`CONFIGURE_MP_APPLICATION` is defined.
 appl-config-option-type: integer
 appl-config-option-constraint:
   min: 0
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml
index c52b5ce3..06d5c2ab 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml
@@ -10,6 +10,9 @@ appl-config-option-name: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
 appl-config-option-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.
 appl-config-option-constraint:
   min: 0
   max: '``UINT32_MAX``'
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml
index d68c3ff3..2f890d39 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml
@@ -7,7 +7,9 @@ appl-config-option-description: |
   a multiprocessor system.
 appl-config-option-index: []
 appl-config-option-name: CONFIGURE_MP_MAXIMUM_NODES
-appl-config-option-notes: null
+appl-config-option-notes: |
+  This configuration option is only evaluated if
+  :ref:`CONFIGURE_MP_APPLICATION` is defined.
 appl-config-option-constraint:
   min: 0
   max: '``UINT32_MAX``'
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml
index 134cda7e..be458cea 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml
@@ -13,6 +13,9 @@ appl-config-option-notes: |
   on this node. This configuration parameter reflects the maximum number of
   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.
 appl-config-option-constraint:
   min: 0
   max: '``UINT32_MAX``'
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
index 4f9ffbff..1dea5397 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
@@ -11,6 +11,9 @@ appl-config-option-notes: |
   RTEMS provides a Shared Memory MPCI Device Driver which can be used on any
   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.
 appl-config-option-constraint:
   custom:
   - |
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml
index 93dd2e38..a1a80b36 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml
@@ -12,6 +12,9 @@ appl-config-option-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.
 appl-config-option-constraint:
   min: 0
   max: '``UINT32_MAX``'