[rtems-central commit] spec: Add header file references

Sebastian Huber sebh at rtems.org
Tue Feb 14 14:01:30 UTC 2023


Module:    rtems-central
Branch:    master
Commit:    d012414620e1e5f2dcabd4ae10605344e40da869
Changeset: http://git.rtems.org/rtems-central/commit/?id=d012414620e1e5f2dcabd4ae10605344e40da869

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Feb 10 11:14:57 2023 +0100

spec: Add header file references

---

 spec/acfg/constraint/mpci-receive-server-stack.yml |  2 +-
 spec/acfg/constraint/stack-space.yml               |  5 +++--
 spec/acfg/constraint/valid-idle-stack-area.yml     |  2 +-
 spec/acfg/constraint/valid-isr-stack-area.yml      |  2 +-
 spec/acfg/constraint/wkspace.yml                   |  2 +-
 spec/acfg/if/executive-ram-size.yml                |  4 ++--
 spec/acfg/if/extra-task-stacks.yml                 |  4 ++--
 spec/acfg/if/idle-task-storage-size.yml            | 10 +++++-----
 spec/acfg/if/init-task-construct-storage-size.yml  |  2 +-
 spec/acfg/if/max-tasks.yml                         |  2 +-
 spec/acfg/if/memory-overhead.yml                   |  4 ++--
 spec/acfg/if/scheduler-user.yml                    |  5 +++--
 spec/acfg/req/extra-task-stacks.yml                |  2 +-
 spec/acfg/req/memory-overhead.yml                  |  2 +-
 spec/rtems/task/if/construct.yml                   |  6 +++---
 15 files changed, 28 insertions(+), 26 deletions(-)

diff --git a/spec/acfg/constraint/mpci-receive-server-stack.yml b/spec/acfg/constraint/mpci-receive-server-stack.yml
index 92a1a8d5..b9710783 100644
--- a/spec/acfg/constraint/mpci-receive-server-stack.yml
+++ b/spec/acfg/constraint/mpci-receive-server-stack.yml
@@ -9,6 +9,6 @@ rationale: null
 text: |
   The value of the application configuration option 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
+  ${../if/header-confdefs:/path} does not overflow an integer of type
   ${/c/if/size_t:/name}.
 type: constraint
diff --git a/spec/acfg/constraint/stack-space.yml b/spec/acfg/constraint/stack-space.yml
index 494f2d48..08facdc0 100644
--- a/spec/acfg/constraint/stack-space.yml
+++ b/spec/acfg/constraint/stack-space.yml
@@ -8,6 +8,7 @@ links:
 rationale: null
 text: |
   The value of the application configuration option shall be small enough so
-  that the task stack space calculation carried out by ``<rtems/confdefs.h>``
-  does not overflow an integer of type ${/c/if/uintptr_t:/name}.
+  that the task stack space calculation carried out by
+  ${../if/header-confdefs:/path} does not overflow an integer of type
+  ${/c/if/uintptr_t:/name}.
 type: constraint
diff --git a/spec/acfg/constraint/valid-idle-stack-area.yml b/spec/acfg/constraint/valid-idle-stack-area.yml
index 32651f54..0eaa252d 100644
--- a/spec/acfg/constraint/valid-idle-stack-area.yml
+++ b/spec/acfg/constraint/valid-idle-stack-area.yml
@@ -9,6 +9,6 @@ rationale: null
 text: |
   The value of the application configuration option 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
+  ${../if/header-confdefs:/path} does not overflow an integer of type
   ${/c/if/size_t:/name}.
 type: constraint
diff --git a/spec/acfg/constraint/valid-isr-stack-area.yml b/spec/acfg/constraint/valid-isr-stack-area.yml
index 2124a285..91cea14f 100644
--- a/spec/acfg/constraint/valid-isr-stack-area.yml
+++ b/spec/acfg/constraint/valid-isr-stack-area.yml
@@ -9,6 +9,6 @@ rationale: null
 text: |
   The value of the application configuration option shall be small enough so
   that the interrupt stack area calculation carried out by
-  ``<rtems/confdefs.h>`` does not overflow an integer of type
+  ${../if/header-confdefs:/path} does not overflow an integer of type
   ${/c/if/size_t:/name}.
 type: constraint
diff --git a/spec/acfg/constraint/wkspace.yml b/spec/acfg/constraint/wkspace.yml
index c8d304fd..0d68eae6 100644
--- a/spec/acfg/constraint/wkspace.yml
+++ b/spec/acfg/constraint/wkspace.yml
@@ -9,6 +9,6 @@ rationale: null
 text: |
   The value of the application configuration option shall be small enough so
   that the RTEMS Workspace size calculation carried out by
-  ``<rtems/confdefs.h>`` does not overflow an integer of type
+  ${../if/header-confdefs:/path} does not overflow an integer of type
   ${/c/if/uintptr_t:/name}.
 type: constraint
diff --git a/spec/acfg/if/executive-ram-size.yml b/spec/acfg/if/executive-ram-size.yml
index a9274c9c..7d9dec5d 100644
--- a/spec/acfg/if/executive-ram-size.yml
+++ b/spec/acfg/if/executive-ram-size.yml
@@ -4,8 +4,8 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 default-value: |
   If this configuration option is undefined, then the RTEMS Workspace and task
-  stack space size is calculated by ``<rtems/confdefs.h>`` based on the values
-  configuration options.
+  stack space size is calculated by ${header-confdefs:/path} based on the
+  values configuration options.
 description: |
   The value of this configuration option defines the RTEMS Workspace size in
   bytes.
diff --git a/spec/acfg/if/extra-task-stacks.yml b/spec/acfg/if/extra-task-stacks.yml
index d9a4530a..3170049c 100644
--- a/spec/acfg/if/extra-task-stacks.yml
+++ b/spec/acfg/if/extra-task-stacks.yml
@@ -6,7 +6,7 @@ default-value: 0
 description: |
   The value of this configuration option defines the number of bytes the
   applications wishes to add to the task stack requirements calculated by
-  ``<rtems/confdefs.h>``.
+  ${header-confdefs:/path}.
 enabled-by: true
 index-entries:
 - memory for task tasks
@@ -26,5 +26,5 @@ name: CONFIGURE_EXTRA_TASK_STACKS
 notes: |
   This parameter is very important.  If the application creates tasks with
   stacks larger then the minimum, then that memory is **not** accounted for by
-  ``<rtems/confdefs.h>``.
+  ${header-confdefs:/path}.
 type: interface
diff --git a/spec/acfg/if/idle-task-storage-size.yml b/spec/acfg/if/idle-task-storage-size.yml
index 66353a4a..f98fd5e1 100644
--- a/spec/acfg/if/idle-task-storage-size.yml
+++ b/spec/acfg/if/idle-task-storage-size.yml
@@ -9,8 +9,8 @@ default-value: |
 description: |
   If this configuration option is specified, then the task storage areas for
   the ${/glossary/idletask:/plural} are statically allocated by
-  <rtems/confdefs.h>.  The value of this configuration option defines the size
-  in bytes of the task storage area of each IDLE task in the system.
+  ${header-confdefs:/path}.  The value of this configuration option defines the
+  size in bytes of the task storage area of each IDLE task in the system.
 enabled-by: true
 index-entries:
 - IDLE task storage size
@@ -41,9 +41,9 @@ notes: |
   system initialization.
 
   The value of this configuration option is passed to
-  ${/rtems/task/if/storage-size:/name} by <rtems/confdefs.h> to determine the
-  actual size of the statically allocated area to take architecture-specific
-  overheads into account.
+  ${/rtems/task/if/storage-size:/name} by ${header-confdefs:/path} to determine
+  the actual size of the statically allocated area to take
+  architecture-specific overheads into account.
 
   The
 
diff --git a/spec/acfg/if/init-task-construct-storage-size.yml b/spec/acfg/if/init-task-construct-storage-size.yml
index 4522945c..f67ad28a 100644
--- a/spec/acfg/if/init-task-construct-storage-size.yml
+++ b/spec/acfg/if/init-task-construct-storage-size.yml
@@ -26,7 +26,7 @@ notes: |
   If this configuration option is specified, then
 
   * a task storage area of the specified size is statically allocated by
-    ``<rtems/confdefs.h>`` for the Classic API initialization task,
+    ${header-confdefs:/path} for the Classic API initialization task,
 
   * the Classic API initialization task is constructed by
     ${/rtems/task/if/construct:/name} instead of using
diff --git a/spec/acfg/if/max-tasks.yml b/spec/acfg/if/max-tasks.yml
index f03cf073..f5f9bfcd 100644
--- a/spec/acfg/if/max-tasks.yml
+++ b/spec/acfg/if/max-tasks.yml
@@ -37,7 +37,7 @@ notes: |
   The maximum number of POSIX threads is specified by
   ${max-posix-threads:/name}.
 
-  A future enhancement to ``<rtems/confdefs.h>`` could be to eliminate the
+  A future enhancement to ${header-confdefs:/path} could be to eliminate the
   assumption that all tasks have floating point enabled. This would require
   the addition of a new configuration parameter to specify the number of
   tasks which enable floating point support.
diff --git a/spec/acfg/if/memory-overhead.yml b/spec/acfg/if/memory-overhead.yml
index c0df65bc..8699cbd9 100644
--- a/spec/acfg/if/memory-overhead.yml
+++ b/spec/acfg/if/memory-overhead.yml
@@ -6,7 +6,7 @@ default-value: 0
 description: |
   The value of this configuration option defines the number of kilobytes the
   application wishes to add to the RTEMS Workspace size calculated by
-  ``<rtems/confdefs.h>``.
+  ${header-confdefs:/path}.
 enabled-by: true
 index-entries: []
 interface-type: appl-config-option
@@ -26,7 +26,7 @@ links:
 name: CONFIGURE_MEMORY_OVERHEAD
 notes: |
   This configuration option should only be used when it is suspected that a bug
-  in ``<rtems/confdefs.h>`` has resulted in an underestimation.  Typically the
+  in ${header-confdefs:/path} has resulted in an underestimation.  Typically the
   memory allocation will be too low when an application does not account for
   all message queue buffers or task stacks, see
   ${message-buffer-memory:/name}.
diff --git a/spec/acfg/if/scheduler-user.yml b/spec/acfg/if/scheduler-user.yml
index 18860b4c..85134dca 100644
--- a/spec/acfg/if/scheduler-user.yml
+++ b/spec/acfg/if/scheduler-user.yml
@@ -40,6 +40,7 @@ notes: |
   are evolving and not fully documented.  It is recommended that you look at
   the existing Deterministic Priority Scheduler in
   ``cpukit/score/src/schedulerpriority*.c`` for guidance.  For guidance on
-  the configuration macros, please examine ``cpukit/sapi/include/confdefs.h``
-  for how these are defined for the Deterministic Priority Scheduler.
+  the configuration macros, please examine
+  ``cpukit/include/rtems/confdefs/scheduler.h`` for how these are defined for
+  the Deterministic Priority Scheduler.
 type: interface
diff --git a/spec/acfg/req/extra-task-stacks.yml b/spec/acfg/req/extra-task-stacks.yml
index 695d19a5..e48a46b3 100644
--- a/spec/acfg/req/extra-task-stacks.yml
+++ b/spec/acfg/req/extra-task-stacks.yml
@@ -14,5 +14,5 @@ requirement-type: functional
 text: |
   The application configuration option shall define the number of bytes the
   applications wishes to add to the task stack requirements calculated by
-  ``<rtems/confdefs.h>``.
+  ${../if/header-confdefs:/path}.
 type: requirement
diff --git a/spec/acfg/req/memory-overhead.yml b/spec/acfg/req/memory-overhead.yml
index 7e82a77a..6f3b8d0c 100644
--- a/spec/acfg/req/memory-overhead.yml
+++ b/spec/acfg/req/memory-overhead.yml
@@ -14,5 +14,5 @@ requirement-type: functional
 text: |
   The application configuration option shall define the number of kilobytes the
   application wishes to add to the RTEMS Workspace size calculated by
-  ``<rtems/confdefs.h>``.
+  ${../if/header-confdefs:/path}.
 type: requirement
diff --git a/spec/rtems/task/if/construct.yml b/spec/rtems/task/if/construct.yml
index 034132d7..814db87a 100644
--- a/spec/rtems/task/if/construct.yml
+++ b/spec/rtems/task/if/construct.yml
@@ -54,9 +54,9 @@ notes: |
   allocators.  This can simplify the application architecture as well as any
   analysis that may be required.
 
-  The stack space estimate done by <rtems/confdefs.h> assumes that all tasks
-  are created by ${create:/name}.  The estimate can be adjusted to take
-  user-provided task storage areas into account through the
+  The stack space estimate done by ${/acfg/if/header-confdefs:/path} assumes
+  that all tasks are created by ${create:/name}.  The estimate can be adjusted
+  to take user-provided task storage areas into account through the
   ${/acfg/if/min-tasks-with-user-provided-storage:/name} application
   configuration option.
 



More information about the vc mailing list