summaryrefslogtreecommitdiffstats
path: root/spec/acfg
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-30 13:31:28 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-30 13:31:28 +0200
commit217c11150235a4abec2b18547028664cb6f66f82 (patch)
treeb9909dc8e60611a024a16faf32bdf8f90e55bdd5 /spec/acfg
parentspec: Avoid self references (diff)
downloadrtems-central-217c11150235a4abec2b18547028664cb6f66f82.tar.bz2
spec: Replace "must" with "shall"
Diffstat (limited to 'spec/acfg')
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml6
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml6
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml6
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml6
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml12
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml2
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml4
-rw-r--r--spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml2
67 files changed, 94 insertions, 94 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml
index c36191fb..62ff60e0 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml
@@ -11,7 +11,7 @@ appl-config-option-description: |
configured.
appl-config-option-index: []
appl-config-option-notes: |
- Filesystems must be initialized to support file descriptor based device
+ Filesystems shall be initialized to support file descriptor based device
drivers and basic input/output functions such as :c:func:`printf`.
Filesystems can be disabled to reduce the memory footprint of an application.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml
index a610cfcc..99f7d985 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml
@@ -14,7 +14,7 @@ appl-config-option-notes: |
of using the Hello World example as the baseline for an application and
leaving out a clock tick source.
- The application must define exactly one of the following configuration options
+ The application shall define exactly one of the following configuration options
* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml
index 85df8c60..55dd2798 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml
@@ -17,7 +17,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a list of initializers for
+ The value of this configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml
index 1c79da52..1d632495 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml
@@ -10,7 +10,7 @@ appl-config-option-notes: |
The Clock Driver is responsible for providing a regular interrupt
which invokes a clock tick directive.
- The application must define exactly one of the following configuration options
+ The application shall define exactly one of the following configuration options
* `CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml
index 957ea2f7..76a8175d 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml
@@ -10,7 +10,7 @@ appl-config-option-notes: |
The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS
Testsuite. Applications should not use this driver.
- The application must define exactly one of the following configuration options
+ The application shall define exactly one of the following configuration options
* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml
index e3f118ad..dd3848b0 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml
@@ -18,7 +18,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a list of initializers for
+ The value of this configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml
index a23ef826..e4de34e9 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml
@@ -12,7 +12,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
min: 0
custom:
- - It must be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
+ - It shall be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
derived: false
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml
index cc6cb959..8cf8401a 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml
@@ -11,7 +11,7 @@ appl-config-option-name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid task priority of the
+ The value of this configuration option shall be a valid task priority of the
configured scheduler.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml
index 5f2afeae..a675975a 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml
@@ -14,10 +14,10 @@ appl-config-option-constraint:
max: '``SIZE_MAX``'
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml
index 40b700ff..f19eb7aa 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml
@@ -21,7 +21,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void *( *idle_body )( uintptr_t )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml
index f9d8e0f7..2d1b5672 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml
@@ -19,10 +19,10 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- It must be greater than or equal to a BSP-specific and application-specific
+ It shall be greater than or equal to a BSP-specific and application-specific
minimum value.
- |
- It must be small enough so that the IDLE task stack area calculation
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml
index 1202ab23..016aa319 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml
@@ -20,7 +20,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a list of initializers for
+ The value of this configuration option shall be a list of initializers for
structures of type :c:type:`rtems_extensions_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml
index 14947b84..7826e515 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml
@@ -19,10 +19,10 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- It must be greater than or equal to a BSP-specific and application-specific
+ It shall be greater than or equal to a BSP-specific and application-specific
minimum value.
- |
- It must be small enough so that the interrupt stack area calculation
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml
index ac53affd..124f0848 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml
@@ -21,7 +21,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a list of initializers for
+ The value of this configuration option shall be a list of initializers for
structures of type :c:type:`rtems_extensions_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml
index f8619991..1f00f5e9 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml
@@ -17,7 +17,7 @@ appl-config-option-constraint:
min: 0
custom:
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml
index 4ceca122..a4f9f327 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml
@@ -9,7 +9,7 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_IDLE_TASK_BODY
appl-config-option-notes: |
- IDLE threads must not block. A blocking IDLE thread results in undefined
+ IDLE threads shall not block. A blocking IDLE thread results in undefined
system behaviour because the scheduler assume that at least one ready thread
exists.
@@ -18,7 +18,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void *( *idle_body )( uintptr_t )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml
index 4661d336..e5290502 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml
@@ -14,16 +14,16 @@ appl-config-option-name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
appl-config-option-notes: |
If you use this option be careful, the user IDLE task **cannot** block at all
during the initialization sequence. Further, once application
- initialization is complete, it must make itself preemptible and enter an idle
+ initialization is complete, it shall make itself preemptible and enter an idle
body loop.
- The IDLE task must run at the lowest priority of all tasks in the system.
+ The IDLE task shall run at the lowest priority of all tasks in the system.
If this configuration option is defined, then it is mandatory to configure a
user IDLE task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option,
otherwise a compile time error in the configuration file will occur.
- The application must define exactly one of the following configuration
+ The application shall define exactly one of the following configuration
options
* :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml
index f08114e7..ab483664 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml
@@ -13,10 +13,10 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- It must be greater than or equal to a BSP-specific and application-specific
+ It shall be greater than or equal to a BSP-specific and application-specific
minimum value.
- |
- It must be small enough so that the IDLE task stack area calculation
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml
index 5268cd7f..4bab7868 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml
@@ -15,7 +15,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a list of initializers for
+ The value of this configuration option shall be a list of initializers for
structures of type :c:type:`rtems_extensions_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml
index ecab24e4..a3c4b862 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml
@@ -14,7 +14,7 @@ appl-config-option-range: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid integer of type
+ The value of this configuration option shall be a valid integer of type
``rtems_task_argument``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml
index 249e78f6..2aa8b694 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml
@@ -12,7 +12,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid task attribute set.
+ The value of this configuration option shall be a valid task attribute set.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
derived: false
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml
index 4b434ba4..af9456c2 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml
@@ -9,11 +9,11 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_INIT_TASK_ENTRY_POINT
appl-config-option-notes: |
- The user must implement the function referenced by this configuration option.
+ The user shall implement the function referenced by this configuration option.
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void ( *entry_point )( rtems_task_argument )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml
index f3a43ba8..ebc5f0b8 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml
@@ -14,7 +14,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid task mode set.
+ The value of this configuration option shall be a valid task mode set.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
derived: false
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml
index 96edc68f..f33d9a00 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml
@@ -13,7 +13,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid integer of type
+ The value of this configuration option shall be a valid integer of type
``rtems_name``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml
index e001a673..9f0e75c7 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml
@@ -12,7 +12,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid task priority. The
+ The value of this configuration option shall be a valid task priority. The
set of valid task priorities is scheduler-specific.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml
index 4e06c887..aa6fdcdf 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml
@@ -13,7 +13,7 @@ appl-config-option-constraint:
min: ':ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`'
custom:
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml
index 9b0d269c..e2ba3438 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml
@@ -11,7 +11,7 @@ appl-config-option-index:
- interrupt stack size
appl-config-option-name: CONFIGURE_INTERRUPT_STACK_SIZE
appl-config-option-notes: |
- The interrupt stack size must be aligned according to
+ The interrupt stack size shall be aligned according to
``CPU_INTERRUPT_STACK_ALIGNMENT``.
There is one interrupt stack available for each configured processor
@@ -32,10 +32,10 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- It must be greater than or equal to a BSP-specific and application-specific
+ It shall be greater than or equal to a BSP-specific and application-specific
minimum value.
- |
- It must be small enough so that the interrupt stack area calculation
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml
index a2f8083a..10d5d4a0 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml
index 20ee436c..94774dbf 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml
@@ -11,7 +11,7 @@ appl-config-option-index: []
appl-config-option-name: CONFIGURE_MAXIMUM_DRIVERS
appl-config-option-notes: |
If the application will dynamically install device drivers, then this
- configuration parameter must be larger than the number of statically
+ configuration parameter shall be larger than the number of statically
configured device drivers. Drivers configured using the
``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options are
statically installed.
@@ -19,10 +19,10 @@ appl-config-option-constraint:
max: '``SIZE_MAX``'
custom:
- |
- It must be greater than or equal than the number of statically configured
+ It shall be greater than or equal than the number of statically configured
device drivers.
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml
index 94b504e4..3be38f35 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml
@@ -16,7 +16,7 @@ appl-config-option-constraint:
max: '``SIZE_MAX``'
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml
index bce9b2c4..cbecab7a 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml
@@ -17,7 +17,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml
index 651bc49d..bad5f776 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml
index 59b1c8d8..bb2702a4 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml
index e8033e7f..6db09347 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml
index e275fc66..8f86e3b1 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml
index 1ea9ad4a..96932604 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml
@@ -22,7 +22,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml
index 10c0652f..18545ecd 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml
@@ -17,7 +17,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
index fafb8712..c9e06073 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml
@@ -17,7 +17,7 @@ appl-config-option-constraint:
max: '``SIZE_MAX``'
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml
index 464fe86f..6e8ddbb5 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml
@@ -19,7 +19,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml
index 50076cda..08c886bc 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml
@@ -28,10 +28,10 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
index aef189e4..82e0ddbe 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml
@@ -18,7 +18,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml
index 3e8d2728..72ef5cd1 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml
@@ -38,7 +38,7 @@ appl-config-option-notes: |
priority levels (default), 48 bytes for 4 priority levels
(``CONFIGURE_MAXIMUM_PRIORITY == 3``).
- The default value is 255, because RTEMS must support 256 priority levels to
+ The default value is 255, because RTEMS shall support 256 priority levels to
be compliant with various standards. These priorities range from 0 to 255.
appl-config-option-constraint:
set:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml
index 0a744693..d1634ec7 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml
index 531453f1..85f2066b 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml
@@ -19,7 +19,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml
index 448c5696..2277c693 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml
@@ -31,10 +31,10 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
- |
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml
index 1249acd5..0dd44dfa 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml
@@ -21,7 +21,7 @@ appl-config-option-constraint:
max: '``SIZE_MAX``'
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml
index 0ef09705..18d65fa7 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml
@@ -15,7 +15,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
- |
The value may be defined through :c:func:`rtems_resource_unlimited` the
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml
index 0dc20374..1d8eafaf 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml
@@ -14,7 +14,7 @@ appl-config-option-constraint:
max: 65535
custom:
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml
index 6783dc17..e612dba5 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml
@@ -18,7 +18,7 @@ appl-config-option-constraint:
min: 0
custom:
- |
- It must be small enough so that the RTEMS Workspace size calculation
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml
index 596378e8..83f95ddf 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml
@@ -60,7 +60,7 @@ appl-config-option-constraint:
min: 0
custom:
- |
- It must be small enough so that the RTEMS Workspace size calculation
+ 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``.
appl-config-option-range: |
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml
index 33cc1bdc..10455ec8 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml
@@ -32,8 +32,8 @@ appl-config-option-notes: |
of a clock tick quantum.
appl-config-option-constraint:
custom:
- - It must be greater than or equal to a Clock Driver specific value.
- - It must be less than or equal to a Clock Driver specific value.
+ - It shall be greater than or equal to a Clock Driver specific value.
+ - It shall be less than or equal to a Clock Driver specific value.
- The resulting clock ticks per second should be an integer.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml
index 7d174a94..aa3e2a77 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml
@@ -16,7 +16,7 @@ appl-config-option-constraint:
min: 0
custom:
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml
index 762af8ab..35693e11 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml
@@ -15,7 +15,7 @@ appl-config-option-notes: |
This parameter can be used to lower the minimum from that recommended. This
can be used in low memory systems to reduce memory consumption for
- stacks. However, this must be done with caution as it could increase the
+ stacks. However, this shall be done with caution as it could increase the
possibility of a blown task stack.
This parameter can be used to increase the minimum from that
@@ -32,10 +32,10 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- It must be greater than or equal to a BSP-specific and application-specific
+ It shall be greater than or equal to a BSP-specific and application-specific
minimum value.
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
index 1900d536..4f9ffbff 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml
@@ -14,7 +14,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a pointer to
+ The value of this configuration option shall be a pointer to
:c:type:`rtems_mpci_table`.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml
index aa602c0f..535f64b2 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml
@@ -8,11 +8,11 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
appl-config-option-notes: |
- The user must implement the function referenced by this configuration option.
+ The user shall implement the function referenced by this configuration option.
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void *( *entry_point )( void * )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml
index 6cf8424d..d81e8949 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml
@@ -13,7 +13,7 @@ appl-config-option-constraint:
min: ':ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`'
custom:
- |
- It must be small enough so that the task stack space calculation carried
+ 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``.
copyrights:
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml
index aa85c268..1cd46976 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml
@@ -7,7 +7,7 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_TABLE
appl-config-option-notes: |
- The application must define exactly one of the following configuration
+ The application shall define exactly one of the following configuration
options
* :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml
index 867ddead..e3749cc6 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml
@@ -15,9 +15,9 @@ appl-config-option-constraint:
min: 16
max: '``SIZE_MAX``'
custom:
- - It must be a power of two.
+ - It shall be a power of two.
- |
- It must be less than or equal to a BSP-specific value which depends on the
+ It shall be less than or equal to a BSP-specific value which depends on the
memory size of the platform available to the application.
copyrights:
- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml
index fdc7a4d0..b4346e80 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml
@@ -7,7 +7,7 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_RTEMS_INIT_TASKS_TABLE
appl-config-option-notes: |
- The application must define exactly one of the following configuration
+ The application shall define exactly one of the following configuration
options
* `CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml
index 2e72a75f..f2224331 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml
@@ -34,7 +34,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid integer of type
+ The value of this configuration option shall be a valid integer of type
``rtems_name``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml
index 0da75a1f..23ae9574 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml
@@ -2,7 +2,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
active: true
appl-config-option-type: feature-enable
appl-config-option-description: |
- In case this configuration option is defined, then the user must provide a
+ In case this configuration option is defined, then the user shall provide a
scheduler algorithm to the application.
appl-config-option-index: []
appl-config-option-name: CONFIGURE_SCHEDULER_USER
@@ -11,18 +11,18 @@ appl-config-option-notes: |
Think twice before you use it.
RTEMS allows the application to provide its own task/thread scheduling
- algorithm. In order to do this, one must define
+ algorithm. In order to do this, one shall define
``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own
scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the
- following additional macros must be defined:
+ following additional macros shall be defined:
- - ``CONFIGURE_SCHEDULER`` must be defined to a static definition of
+ - ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
the scheduler data structures of the user scheduler.
- - ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` must be defined to a scheduler
+ - ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
table entry initializer for the user scheduler.
- - ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` must be defined to the type of
+ - ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
the per-thread information of the user scheduler.
At this time, the mechanics and requirements for writing a new scheduler
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml
index 485f284c..e39615ec 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml
@@ -11,7 +11,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid Classic API task
+ The value of this configuration option shall be a valid Classic API task
priority. The set of valid task priorities is scheduler-specific.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml
index e643125e..e5f48f63 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml
@@ -12,7 +12,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be a valid Classic API task
+ The value of this configuration option shall be a valid Classic API task
priority. The set of valid task priorities is scheduler-specific.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml
index c6dcd5b4..b9c80bc3 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml
@@ -11,7 +11,7 @@ appl-config-option-index:
- task stack allocator
appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR
appl-config-option-notes: |
- A correctly configured system must configure the following to be consistent:
+ A correctly configured system shall configure the following to be consistent:
- :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
@@ -21,7 +21,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void *( *allocate )( size_t )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml
index fee5437c..cdf90e39 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml
@@ -8,7 +8,7 @@ appl-config-option-description: |
appl-config-option-index: []
appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
appl-config-option-notes: |
- A correctly configured system must configure the following to be consistent:
+ A correctly configured system shall configure the following to be consistent:
- `CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
@@ -18,7 +18,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void ( *initialize )( size_t )`` or to ``NULL``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml
index ddf1bef7..c507ee82 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml
@@ -11,7 +11,7 @@ appl-config-option-index:
- task stack deallocator
appl-config-option-name: CONFIGURE_TASK_STACK_DEALLOCATOR
appl-config-option-notes: |
- A correctly configured system must configure the following to be consistent:
+ A correctly configured system shall configure the following to be consistent:
- :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
@@ -21,7 +21,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must be defined to a valid function
+ The value of this configuration option shall be defined to a valid function
pointer of the type ``void ( *deallocate )( void * )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml
index 9201e4e4..f4ee2a7a 100644
--- a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml
@@ -18,7 +18,7 @@ appl-config-option-notes: |
appl-config-option-constraint:
custom:
- |
- The value of this configuration option must meet the constraints of all
+ The value of this configuration option shall meet the constraints of all
object classes to which it is applied.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)