summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-28 09:03:14 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-29 21:00:43 +0200
commit4565256f2433ad899525114985baa1bfb99964e1 (patch)
treea690be04ebda18f6d8ebc9b87ba624cf16760ae6
parent8f1daf7c823989916428354eb9d2cc5c4b6d5b06 (diff)
downloadrtems-docs-4565256f2433ad899525114985baa1bfb99964e1.tar.bz2
c-user: Reformat configuration option constraints
If only one constraint is present, then use a single sentence, otherwise use a list for the constraints. Format the constraints so that the line length limit is maintained.
-rw-r--r--c-user/config/bdbuf.rst94
-rw-r--r--c-user/config/bsp-related.rst22
-rw-r--r--c-user/config/classic-api.rst176
-rw-r--r--c-user/config/classic-init-task.rst28
-rw-r--r--c-user/config/device-driver.rst18
-rw-r--r--c-user/config/event-record.rst11
-rw-r--r--c-user/config/filesystem.rst6
-rw-r--r--c-user/config/general.rst114
-rw-r--r--c-user/config/idle-task.rst12
-rw-r--r--c-user/config/mpci.rst50
-rw-r--r--c-user/config/posix-api.rst168
-rw-r--r--c-user/config/posix-init-thread.rst11
-rw-r--r--c-user/config/scheduler-general.rst28
-rw-r--r--c-user/config/task-stack-alloc.rst6
14 files changed, 414 insertions, 330 deletions
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 7377bee..c5381e1 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -76,9 +76,10 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
+ * It shall be an integral multiple of
+ :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
DESCRIPTION:
The value of this configuration option defines the maximum size of a buffer
@@ -106,8 +107,13 @@ DEFAULT VALUE:
The default value is 512.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the minimum size of a buffer
@@ -135,8 +141,13 @@ DEFAULT VALUE:
The default value is 32768.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
DESCRIPTION:
The value of this configuration option defines the size of the cache memory
@@ -164,8 +175,13 @@ DEFAULT VALUE:
The default value is 0.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum blocks per
@@ -195,8 +211,13 @@ DEFAULT VALUE:
The default value is 16.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum blocks per write
@@ -225,7 +246,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ priority. The set of valid task priorities depends on the scheduler
+ configuration.
DESCRIPTION:
The value of this configuration option defines the read-ahead task priority.
@@ -255,15 +277,16 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ * It shall be greater than or equal to
+ :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
- * It 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.
+ * It 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.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the task stack size of the
@@ -291,8 +314,13 @@ DEFAULT VALUE:
The default value is 1000.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the swapout task maximum block
@@ -320,8 +348,13 @@ DEFAULT VALUE:
The default value is 250.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the swapout task swap period
@@ -350,7 +383,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ priority. The set of valid task priorities depends on the scheduler
+ configuration.
DESCRIPTION:
The value of this configuration option defines the swapout task priority.
@@ -377,8 +411,13 @@ DEFAULT VALUE:
The default value is 0.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the swapout worker task count.
@@ -406,7 +445,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ priority. The set of valid task priorities depends on the scheduler
+ configuration.
DESCRIPTION:
The value of this configuration option defines the swapout worker task
diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
index 2adf49c..45f31a8 100644
--- a/c-user/config/bsp-related.rst
+++ b/c-user/config/bsp-related.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -87,12 +87,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
- * It shall be small enough so that the IDLE
- task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+ * It shall be small enough so that the IDLE task stack area calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION:
If
@@ -165,12 +165,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
- * It shall be small enough so that the
- interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+ * It shall be small enough so that the interrupt stack area calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
* It shall be aligned according to
:c:macro:`CPU_INTERRUPT_STACK_ALIGNMENT`.
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
index 74a8257..4643572 100644
--- a/c-user/config/classic-api.rst
+++ b/c-user/config/classic-api.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -47,18 +47,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -90,18 +90,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -135,18 +135,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -178,18 +178,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -221,18 +221,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -264,18 +264,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -307,18 +307,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -354,22 +354,22 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -414,11 +414,13 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
- * It shall be an integral multiple of :c:macro:`RTEMS_TASK_STORAGE_ALIGNMENT`.
+ * It shall be an integral multiple of
+ :c:macro:`RTEMS_TASK_STORAGE_ALIGNMENT`.
DESCRIPTION:
If the value of this configuration option is greater than zero, then it
@@ -466,18 +468,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -509,13 +511,13 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of Classic
@@ -543,8 +545,12 @@ DEFAULT VALUE:
The default value is 0.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to :ref:`CONFIGURE_MAXIMUM_TASKS`.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to :ref:`CONFIGURE_MAXIMUM_TASKS`.
DESCRIPTION:
The value of this configuration option defines the minimum count of Classic
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
index 0743929..9c0435b 100644
--- a/c-user/config/classic-init-task.rst
+++ b/c-user/config/classic-init-task.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -45,8 +45,8 @@ DEFAULT VALUE:
The default value is 0.
VALUE CONSTRAINTS:
- The value of this configuration option shall be a valid integer of type
- :c:type:`rtems_task_argument`.
+ The value of this configuration option shall be convertible to an integer
+ of type :c:type:`rtems_task_argument`.
DESCRIPTION:
The value of this configuration option defines task argument of the Classic
@@ -107,10 +107,10 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ * It shall be greater than or equal to
+ :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
- * It shall be defined using
- :c:func:`RTEMS_TASK_STORAGE_SIZE`.
+ * It shall be defined using :c:func:`RTEMS_TASK_STORAGE_SIZE`.
DESCRIPTION:
The value of this configuration option defines the task storage size of the
@@ -222,8 +222,8 @@ DEFAULT VALUE:
The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``.
VALUE CONSTRAINTS:
- The value of this configuration option shall be a valid integer of type
- :c:type:`rtems_name`.
+ The value of this configuration option shall be convertible to an integer
+ of type :c:type:`rtems_name`.
DESCRIPTION:
The value of this configuration option defines the name of the Classic API
@@ -252,7 +252,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ priority. The set of valid task priorities depends on the scheduler
+ configuration.
DESCRIPTION:
The value of this configuration option defines the initial priority of the
@@ -283,11 +284,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ * It shall be greater than or equal to
+ :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the task stack size of the
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index 05ae08a..22002f9 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -594,7 +594,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ priority. The set of valid task priorities depends on the scheduler
+ configuration.
DESCRIPTION:
The value of this configuration option defines the ATA task priority.
@@ -661,14 +662,15 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
- * It shall be greater than or equal than the number of statically configured
- device drivers.
+ * It shall be greater than or equal than the number of statically
+ configured device drivers.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the number of device drivers.
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index cbe02e3..fa1d011 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2019, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
@@ -147,13 +147,14 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 16.
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be a power of two.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the event record item count
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 5b1b414..05ca826 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -739,8 +739,8 @@ DEFAULT VALUE:
The default value is 128.
VALUE CONSTRAINTS:
- The value of this configuration option shall be
- an element of {16, 32, 64, 128, 256, 512}.
+ The value of this configuration option shall be equal to 16, 32, 64, 128,
+ 256, or 512.
DESCRIPTION:
The value of this configuration option defines the block size for in-memory
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index 024b5c4..203c3e8 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -111,13 +111,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `UINTPTR_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be less than or equal to `UINTPTR_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the RTEMS Workspace size in
@@ -150,11 +151,11 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the number of bytes the
@@ -221,12 +222,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
- * It shall be small enough so that the
- interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+ * It shall be small enough so that the interrupt stack area calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
* It shall be aligned according to
:c:macro:`CPU_INTERRUPT_STACK_ALIGNMENT`.
@@ -306,13 +307,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of file
@@ -341,8 +343,12 @@ DEFAULT VALUE:
The default value is 1.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 1
- and less than or equal to :c:macro:`CPU_MAXIMUM_PROCESSORS`.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to one.
+
+ * It shall be less than or equal to :c:macro:`CPU_MAXIMUM_PROCESSORS`.
DESCRIPTION:
The value of this configuration option defines the maximum number of
@@ -382,13 +388,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum thread name size
@@ -425,15 +432,15 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the number of kilobytes the
@@ -472,15 +479,15 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the number of bytes reserved
@@ -557,9 +564,11 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to a Clock Driver specific value.
+ * It shall be greater than or equal to a value defined by the :term:`Clock
+ Driver`.
- * It shall be less than or equal to a Clock Driver specific value.
+ * It shall be less than or equal to a value defined by the :term:`Clock
+ Driver`.
* The resulting clock ticks per second should be an integer.
@@ -612,12 +621,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
DESCRIPTION:
The value of this configuration option defines the minimum stack size in
@@ -695,8 +704,13 @@ DEFAULT VALUE:
The default value is 50.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the length of the timeslice
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst
index 9330672..1234f42 100644
--- a/c-user/config/idle-task.rst
+++ b/c-user/config/idle-task.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -129,12 +129,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
- * It shall be small enough so that the IDLE
- task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+ * It shall be small enough so that the IDLE task stack area calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION:
The value of this configuration option defines the task stack size for an
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index 0c967c6..800aa30 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -52,14 +52,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
- * It shall be small enough so that the
- MPCI receive server stack area calculation carried out by
- ``<rtems/confdefs.h>`` does not overflow an integer of type
- `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
+ * It shall be small enough so that the MPCI receive server stack area
+ calculation carried out by ``<rtems/confdefs.h>`` does not overflow an
+ integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION:
The value of this configuration option defines the number of bytes the
@@ -119,8 +119,13 @@ DEFAULT VALUE:
The default value is 32.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum number of
@@ -152,8 +157,13 @@ DEFAULT VALUE:
The default value is 2.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum number of nodes in
@@ -182,8 +192,13 @@ DEFAULT VALUE:
The default value is 32.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum number of
@@ -252,8 +267,13 @@ DEFAULT VALUE:
The default value is ``NODE_NUMBER``.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
+ The value of this configuration option shall satisfy all of the following
+ constraints:
+
+ * It shall be greater than or equal to zero.
+
+ * It shall be less than or equal to `UINT32_MAX
+ <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the node number of this node
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index 592a1ce..3c2c8a2 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -50,18 +50,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -96,18 +96,18 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of key
@@ -142,22 +142,22 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -191,20 +191,19 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -238,22 +237,22 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -290,22 +289,22 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It shall be small enough so that the
- RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
- not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the RTEMS Workspace size calculation
+ carried out by ``<rtems/confdefs.h>`` does not overflow an integer of
+ type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -337,17 +336,17 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -389,23 +388,22 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
* It shall be less than or equal to 65535.
- * It 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.
+ * It 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.
- * It may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ * It 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.
- * 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX
@@ -442,12 +440,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
- * It shall be greater than or equal to a
- BSP-specific and application-specific minimum value.
+ * It shall be greater than or equal to a BSP-specific and
+ application-specific minimum value.
DESCRIPTION:
The value of this configuration option defines the minimum stack size in
diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst
index 42542e5..8623f2c 100644
--- a/c-user/config/posix-init-thread.rst
+++ b/c-user/config/posix-init-thread.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -78,11 +78,12 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ * It shall be greater than or equal to
+ :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
- * It shall be small enough so that the task
- stack space calculation carried out by ``<rtems/confdefs.h>`` does not
- overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+ * It shall be small enough so that the task stack space calculation carried
+ out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+ `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION:
The value of this configuration option defines the thread stack size of the
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 516d9d3..d78b14a 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 2010 Gedare Bloom
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -69,13 +69,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be greater than or equal to 0.
+ * It shall be greater than or equal to zero.
- * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
+ * It shall be less than or equal to `SIZE_MAX
+ <https://en.cppreference.com/w/c/types/limits>`_.
- * It 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.
+ * It 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.
DESCRIPTION:
The value of this configuration option defines the maximum number Constant
@@ -106,8 +107,8 @@ DEFAULT VALUE:
The default value is 255.
VALUE CONSTRAINTS:
- The value of this configuration option shall be
- an element of {3, 7, 31, 63, 127, 255}.
+ The value of this configuration option shall be equal to 3, 7, 31, 63, 127,
+ or 255.
DESCRIPTION:
For the following schedulers
@@ -168,15 +169,14 @@ VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following
constraints:
- * It shall be a list of the following
- macros:
+ * It shall be a list of the following macros:
* ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
* ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
- * It shall be a list of exactly
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.
+ * It shall be a list of exactly :ref:`CONFIGURE_MAXIMUM_PROCESSORS`
+ elements.
DESCRIPTION:
The value of this configuration option is used to initialize the initial
@@ -323,8 +323,8 @@ DEFAULT VALUE:
* ``"UPS "`` for the :ref:`SchedulerPrioritySimple`.
VALUE CONSTRAINTS:
- The value of this configuration option shall be a valid integer of type
- :c:type:`rtems_name`.
+ The value of this configuration option shall be convertible to an integer
+ of type :c:type:`rtems_name`.
DESCRIPTION:
The value of this configuration option defines the name of the default
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index cd174ed..3f779ff 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
-.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
@@ -113,8 +113,8 @@ DEFAULT VALUE:
VALUE CONSTRAINTS:
The value of this configuration option shall be defined to a valid function
- pointer of the type ``void ( *initialize )( size_t )`` or to
- `NULL <https://en.cppreference.com/w/c/types/NULL>`_.
+ pointer of the type ``void ( *initialize )( size_t )`` or to `NULL
+ <https://en.cppreference.com/w/c/types/NULL>`_.
DESCRIPTION:
The value of this configuration option initializes the stack allocator