[rtems-central commit] spec: Review application configuration API
Sebastian Huber
sebh at rtems.org
Mon Nov 9 07:11:38 UTC 2020
Module: rtems-central
Branch: master
Commit: 0587c470eb8016865d1aa833d96eb1059d31c427
Changeset: http://git.rtems.org/rtems-central/commit/?id=0587c470eb8016865d1aa833d96eb1059d31c427
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Nov 6 17:09:29 2020 +0100
spec: Review application configuration API
---
spec/rtems/config/if/api-table.yml | 69 +++++++++++++---------
spec/rtems/config/if/get-api-configuration.yml | 7 ++-
spec/rtems/config/if/get-copyright-notice.yml | 5 +-
spec/rtems/config/if/get-do-zero-of-workspace.yml | 11 ++--
spec/rtems/config/if/get-idle-task-stack-size.yml | 8 ++-
spec/rtems/config/if/get-idle-task.yml | 8 ++-
spec/rtems/config/if/get-interrupt-stack-size.yml | 8 ++-
spec/rtems/config/if/get-maximum-barriers.yml | 9 ++-
spec/rtems/config/if/get-maximum-extensions.yml | 11 ++--
.../rtems/config/if/get-maximum-message-queues.yml | 9 ++-
spec/rtems/config/if/get-maximum-partitions.yml | 9 ++-
spec/rtems/config/if/get-maximum-periods.yml | 11 ++--
spec/rtems/config/if/get-maximum-ports.yml | 11 ++--
spec/rtems/config/if/get-maximum-processors.yml | 12 ++--
spec/rtems/config/if/get-maximum-regions.yml | 11 ++--
spec/rtems/config/if/get-maximum-semaphores.yml | 9 ++-
spec/rtems/config/if/get-maximum-tasks.yml | 9 ++-
spec/rtems/config/if/get-maximum-timers.yml | 9 ++-
spec/rtems/config/if/get-microseconds-per-tick.yml | 9 ++-
spec/rtems/config/if/get-milliseconds-per-tick.yml | 11 ++--
spec/rtems/config/if/get-nanoseconds-per-tick.yml | 9 ++-
.../config/if/get-number-of-initial-extensions.yml | 8 ++-
spec/rtems/config/if/get-stack-allocate-hook.yml | 10 +++-
.../config/if/get-stack-allocate-init-hook.yml | 10 +++-
.../if/get-stack-allocator-avoids-work-space.yml | 9 ++-
spec/rtems/config/if/get-stack-free-hook.yml | 9 ++-
spec/rtems/config/if/get-stack-space-size.yml | 7 ++-
spec/rtems/config/if/get-ticks-per-timeslice.yml | 8 ++-
spec/rtems/config/if/get-unified-work-area.yml | 11 ++--
spec/rtems/config/if/get-user-extension-table.yml | 7 ++-
.../config/if/get-user-multiprocessing-table.yml | 7 ++-
spec/rtems/config/if/get-version-string.yml | 5 +-
spec/rtems/config/if/get-work-space-size.yml | 11 ++--
spec/rtems/config/if/group.yml | 13 ++--
spec/rtems/config/if/has-hardware-fp.yml | 4 +-
spec/rtems/config/if/header-2.yml | 2 +-
spec/rtems/config/if/header.yml | 4 +-
spec/rtems/config/if/resource-is-unlimited.yml | 5 +-
.../config/if/resource-maximum-per-allocation.yml | 5 +-
spec/rtems/config/if/resource-unlimited.yml | 9 +--
spec/rtems/config/if/stack-allocate-hook.yml | 2 +-
spec/rtems/config/if/stack-allocate-init-hook.yml | 2 +-
spec/rtems/config/if/stack-free-hook.yml | 2 +-
spec/rtems/config/if/unlimited-objects.yml | 3 +-
44 files changed, 253 insertions(+), 155 deletions(-)
diff --git a/spec/rtems/config/if/api-table.yml b/spec/rtems/config/if/api-table.yml
index b488a1c..6458985 100644
--- a/spec/rtems/config/if/api-table.yml
+++ b/spec/rtems/config/if/api-table.yml
@@ -7,17 +7,18 @@ copyrights:
definition:
- default:
brief: |
- This member contains the maximum number of Classic API Tasks which are
- configured for this application.
+ This member contains the maximum number of Classic API Tasks configured
+ for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-tasks:/name}.
kind: member
name: maximum_tasks
variants: []
- default:
brief: |
- This member indicates if Classic API Notepads are enabled or disabled for
- this application.
+ This member is true, if the Classic API Notepads are enabled, otherwise
+ it is false.
definition: ${/c/if/bool:/name} ${.:name}
description: null
kind: member
@@ -25,82 +26,91 @@ definition:
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Timers which are
- configured for this application.
+ This member contains the maximum number of Classic API Timers configured
+ for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-timers:/name}.
kind: member
name: maximum_timers
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Semaphores which
- are configured for this application.
+ This member contains the maximum number of Classic API Semaphores
+ configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-semaphores:/name}.
kind: member
name: maximum_semaphores
variants: []
- default:
brief: |
This member contains the maximum number of Classic API Message Queues
- which are configured for this application.
+ configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-message-queues:/name}.
kind: member
name: maximum_message_queues
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Partitions which
- are configured for this application.
+ This member contains the maximum number of Classic API Partitions
+ configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-partitions:/name}.
kind: member
name: maximum_partitions
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Regions which are
- configured for this application.
+ This member contains the maximum number of Classic API Regions configured
+ for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-regions:/name}.
kind: member
name: maximum_regions
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Dual Ported Memory
- Areas which are configured for this application.
+ This member contains the maximum number of Classic API Dual-Ported
+ Memories configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-ports:/name}.
kind: member
name: maximum_ports
variants: []
- default:
brief: |
This member contains the maximum number of Classic API Rate Monotonic
- Periods which are configured for this application.
+ Periods configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-periods:/name}.
kind: member
name: maximum_periods
variants: []
- default:
brief: |
- This member contains the maximum number of Classic API Barriers which are
+ This member contains the maximum number of Classic API Barriers
configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/max-barriers:/name}.
kind: member
name: maximum_barriers
variants: []
- default:
brief: |
This member contains the number of Classic API Initialization
- Tasks which are configured for this application.
+ Tasks configured for this application.
definition: ${/c/if/uint32_t:/name} ${.:name}
- description: null
+ description: |
+ See ${/acfg/if/rtems-init-tasks-table:/name}.
kind: member
name: number_of_initialization_tasks
variants: []
@@ -109,7 +119,8 @@ definition:
This member contains the pointer to Classic API Initialization Tasks
Table of this application.
definition: const ${../../task/if/initialization-table:/name} *${.:name}
- description: null
+ description: |
+ See ${/acfg/if/rtems-init-tasks-table:/name}.
kind: member
name: User_initialization_tasks_table
variants: []
diff --git a/spec/rtems/config/if/get-api-configuration.yml b/spec/rtems/config/if/get-api-configuration.yml
index 79760cf..c163775 100644
--- a/spec/rtems/config/if/get-api-configuration.yml
+++ b/spec/rtems/config/if/get-api-configuration.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the pointer to the Classic API Configuration Table of this
- application.
+ Gets the Classic API Configuration Table of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -24,6 +23,8 @@ name: rtems_configuration_get_rtems_api_configuration
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the pointer to the Classic API Configuration Table of this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-copyright-notice.yml b/spec/rtems/config/if/get-copyright-notice.yml
index ee9c4e7..4b9b91e 100644
--- a/spec/rtems/config/if/get-copyright-notice.yml
+++ b/spec/rtems/config/if/get-copyright-notice.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the pointer to the RTEMS copyright notice.
+ Gets the RTEMS copyright notice.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -23,6 +23,7 @@ name: rtems_get_copyright_notice
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the pointer to the RTEMS copyright notice.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-do-zero-of-workspace.yml b/spec/rtems/config/if/get-do-zero-of-workspace.yml
index 8d265d4..34fae45 100644
--- a/spec/rtems/config/if/get-do-zero-of-workspace.yml
+++ b/spec/rtems/config/if/get-do-zero-of-workspace.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the RTEMS Workspace is zeroed during system initialization
- for this application, otherwise returns false.
+ Indicates if the RTEMS Workspace is configured to be zeroed during system
+ initialization for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -17,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_do_zero_of_workspace
-notes: null
+notes: |
+ See ${/acfg/if/zero-workspace-automatically:/name}.
params: []
return:
- return: null
+ return: |
+ Returns true, if the RTEMS Workspace is configured to be zeroed during
+ system initialization for this application, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-idle-task-stack-size.yml b/spec/rtems/config/if/get-idle-task-stack-size.yml
index 57ce99a..5fff031 100644
--- a/spec/rtems/config/if/get-idle-task-stack-size.yml
+++ b/spec/rtems/config/if/get-idle-task-stack-size.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the IDLE task stack size in bytes of this application.
+ Gets the IDLE task stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,11 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_idle_task_stack_size
-notes: null
+notes: |
+ See ${/acfg/if/idle-task-stack-size:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the IDLE task stack size in bytes of this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-idle-task.yml b/spec/rtems/config/if/get-idle-task.yml
index 86b4367..fad39ed 100644
--- a/spec/rtems/config/if/get-idle-task.yml
+++ b/spec/rtems/config/if/get-idle-task.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the IDLE task entry of this application.
+ Gets the IDLE task entry of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,11 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_idle_task
-notes: null
+notes: |
+ See ${/acfg/if/idle-task-body:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the IDLE task entry of this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-interrupt-stack-size.yml b/spec/rtems/config/if/get-interrupt-stack-size.yml
index 3b32517..6554d82 100644
--- a/spec/rtems/config/if/get-interrupt-stack-size.yml
+++ b/spec/rtems/config/if/get-interrupt-stack-size.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the interrupt stack size in bytes of this application.
+ Gets the interrupt stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,11 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_interrupt_stack_size
-notes: null
+notes: |
+ See ${/acfg/if/interrupt-stack-size:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the interrupt stack size in bytes of this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-barriers.yml b/spec/rtems/config/if/get-maximum-barriers.yml
index 114ffdb..a974e93 100644
--- a/spec/rtems/config/if/get-maximum-barriers.yml
+++ b/spec/rtems/config/if/get-maximum-barriers.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Barriers which are configured for
+ Gets the maximum number of Classic API Barriers configured for
this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_barriers
-notes: null
+notes: |
+ See ${/acfg/if/max-barriers:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Barriers configured for
+ this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-extensions.yml b/spec/rtems/config/if/get-maximum-extensions.yml
index 42940b4..8ade16b 100644
--- a/spec/rtems/config/if/get-maximum-extensions.yml
+++ b/spec/rtems/config/if/get-maximum-extensions.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API User Extensions which are
- configured for this application.
+ Gets the maximum number of Classic API User Extensions configured for this
+ application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_extensions
-notes: null
+notes: |
+ See ${/acfg/if/max-user-extensions:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API User Extensions configured for
+ this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-message-queues.yml b/spec/rtems/config/if/get-maximum-message-queues.yml
index 2164eba..5a8f8ea 100644
--- a/spec/rtems/config/if/get-maximum-message-queues.yml
+++ b/spec/rtems/config/if/get-maximum-message-queues.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Message Queues which are configured
+ Gets the maximum number of Classic API Message Queues configured
for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_message_queues
-notes: null
+notes: |
+ See ${/acfg/if/max-message-queues:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Message Queues configured for
+ this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-partitions.yml b/spec/rtems/config/if/get-maximum-partitions.yml
index ead5a9a..bda6fd0 100644
--- a/spec/rtems/config/if/get-maximum-partitions.yml
+++ b/spec/rtems/config/if/get-maximum-partitions.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Partitions which are configured for
+ Gets the maximum number of Classic API Partitions configured for
this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_partitions
-notes: null
+notes: |
+ See ${/acfg/if/max-partitions:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Partitions configured
+ for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-periods.yml b/spec/rtems/config/if/get-maximum-periods.yml
index 607c06f..55bbe23 100644
--- a/spec/rtems/config/if/get-maximum-periods.yml
+++ b/spec/rtems/config/if/get-maximum-periods.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Rate Monotonic Periods which are
- configured for this application.
+ Gets the maximum number of Classic API Rate Monotonic Periods configured for
+ this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_periods
-notes: null
+notes: |
+ See ${/acfg/if/max-periods:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Rate Monotonic Periods configured
+ for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-ports.yml b/spec/rtems/config/if/get-maximum-ports.yml
index d6a2a04..fad700d 100644
--- a/spec/rtems/config/if/get-maximum-ports.yml
+++ b/spec/rtems/config/if/get-maximum-ports.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Dual Ported Memory Areas which are
- configured for this application.
+ Gets the maximum number of Classic API Dual-Ported Memories configured for
+ this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_ports
-notes: null
+notes: |
+ See ${/acfg/if/max-ports:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Dual-Ported Memories configured
+ for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-processors.yml b/spec/rtems/config/if/get-maximum-processors.yml
index 9b3c036..63f02bf 100644
--- a/spec/rtems/config/if/get-maximum-processors.yml
+++ b/spec/rtems/config/if/get-maximum-processors.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of processors which are configured for this
- application.
+ Gets the maximum number of processors configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -19,13 +18,16 @@ links:
name: rtems_configuration_get_maximum_processors
notes: |
The actual number of processors available to the application is returned by
- ${../../scheduler/if/get-processor-maximum:/name}. It will be less than or
- equal to the configured maximum number of processors.
+ ${../../scheduler/if/get-processor-maximum:/name} which less than or
+ equal to the configured maximum number of processors
+ (${/acfg/if/max-processors:/name}).
In uniprocessor configurations, this macro is a compile time constant which
evaluates to one.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of processors configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-regions.yml b/spec/rtems/config/if/get-maximum-regions.yml
index 3daa639..422882e 100644
--- a/spec/rtems/config/if/get-maximum-regions.yml
+++ b/spec/rtems/config/if/get-maximum-regions.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Regions which are configured for
- this application.
+ Gets the maximum number of Classic API Regions configured for this
+ application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_regions
-notes: null
+notes: |
+ See ${/acfg/if/max-regions:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Regions configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-semaphores.yml b/spec/rtems/config/if/get-maximum-semaphores.yml
index 32817e0..55d6c2f 100644
--- a/spec/rtems/config/if/get-maximum-semaphores.yml
+++ b/spec/rtems/config/if/get-maximum-semaphores.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Semaphores which are configured for
+ Gets the maximum number of Classic API Semaphores configured for
this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_semaphores
-notes: null
+notes: |
+ See ${/acfg/if/max-semaphores:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Semaphores configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-tasks.yml b/spec/rtems/config/if/get-maximum-tasks.yml
index 93d5cf4..56bc6eb 100644
--- a/spec/rtems/config/if/get-maximum-tasks.yml
+++ b/spec/rtems/config/if/get-maximum-tasks.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Tasks which are configured for this
+ Gets the maximum number of Classic API Tasks configured for this
application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_tasks
-notes: null
+notes: |
+ See ${/acfg/if/max-tasks:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Tasks configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-timers.yml b/spec/rtems/config/if/get-maximum-timers.yml
index 96fc094..8d7e7b9 100644
--- a/spec/rtems/config/if/get-maximum-timers.yml
+++ b/spec/rtems/config/if/get-maximum-timers.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number of Classic API Timers which are configured for
+ Gets the maximum number of Classic API Timers configured for
this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -21,9 +21,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_maximum_timers
-notes: null
+notes: |
+ See ${/acfg/if/max-timers:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the maximum number of Classic API Timers configured for
+ this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-microseconds-per-tick.yml b/spec/rtems/config/if/get-microseconds-per-tick.yml
index 94504f9..e6f59a9 100644
--- a/spec/rtems/config/if/get-microseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-microseconds-per-tick.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the number of microseconds per clock tick configured for this
+ Gets the number of microseconds per clock tick configured for this
application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -17,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_microseconds_per_tick
-notes: null
+notes: |
+ See ${/acfg/if/microseconds-per-tick:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the number of microseconds per clock tick configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-milliseconds-per-tick.yml b/spec/rtems/config/if/get-milliseconds-per-tick.yml
index b1ee500..4e1026c 100644
--- a/spec/rtems/config/if/get-milliseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-milliseconds-per-tick.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the number of milliseconds per clock tick configured for this
+ Gets the number of milliseconds per clock tick configured for this
application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
- default: (${/score/watchdog/if/microseconds-per-tick:/name} / 1000)
+ default: ( ${/score/watchdog/if/microseconds-per-tick:/name} / 1000 )
variants: []
description: null
enabled-by: true
@@ -17,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_milliseconds_per_tick
-notes: null
+notes: |
+ See ${/acfg/if/microseconds-per-tick:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the number of milliseconds per clock tick configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-nanoseconds-per-tick.yml b/spec/rtems/config/if/get-nanoseconds-per-tick.yml
index 411c078..04f42c6 100644
--- a/spec/rtems/config/if/get-nanoseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-nanoseconds-per-tick.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the number of microseconds per clock tick configured for this
+ Gets the number of microseconds per clock tick configured for this
application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -17,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_nanoseconds_per_tick
-notes: null
+notes: |
+ See ${/acfg/if/microseconds-per-tick:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the number of microseconds per clock tick configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-number-of-initial-extensions.yml b/spec/rtems/config/if/get-number-of-initial-extensions.yml
index 98ca14e..f485fe0 100644
--- a/spec/rtems/config/if/get-number-of-initial-extensions.yml
+++ b/spec/rtems/config/if/get-number-of-initial-extensions.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the number of initial extensions configured for this application.
+ Gets the number of initial extensions configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,11 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_number_of_initial_extensions
-notes: null
+notes: |
+ See ${/acfg/if/initial-extensions:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the number of initial extensions configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocate-hook.yml b/spec/rtems/config/if/get-stack-allocate-hook.yml
index 69d0ac3..e8ff68b 100644
--- a/spec/rtems/config/if/get-stack-allocate-hook.yml
+++ b/spec/rtems/config/if/get-stack-allocate-hook.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the thread stack allocator allocate hook.
+ Gets the thread stack allocator allocate hook configured for this
+ application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_stack_allocate_hook
-notes: null
+notes: |
+ See ${/acfg/if/task-stack-allocator:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the thread stack allocator allocate hook configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocate-init-hook.yml b/spec/rtems/config/if/get-stack-allocate-init-hook.yml
index 4226e66..a3f60fb 100644
--- a/spec/rtems/config/if/get-stack-allocate-init-hook.yml
+++ b/spec/rtems/config/if/get-stack-allocate-init-hook.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the thread stack allocator initialization hook.
+ Gets the thread stack allocator initialization hook configured for this
+ application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_stack_allocate_init_hook
-notes: null
+notes: |
+ See ${/acfg/if/task-stack-allocator-init:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the thread stack allocator initialization hook configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
index b0aaa7a..99d9b6b 100644
--- a/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
+++ b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the thread stack allocator avoids the RTEMS Workspace,
- otherwise returns false.
+ Indicates if the thread stack allocator is configured to avoid the RTEMS
+ Workspace for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -18,8 +18,11 @@ links:
uid: group
name: rtems_configuration_get_stack_allocator_avoids_work_space
notes: null
+ See ${/acfg/if/task-stack-no-workspace:/name}.
params: []
return:
- return: null
+ return: |
+ Returns true, if the thread stack allocator is configured to avoid the
+ RTEMS Workspace for this application, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-free-hook.yml b/spec/rtems/config/if/get-stack-free-hook.yml
index da70cd3..749194e 100644
--- a/spec/rtems/config/if/get-stack-free-hook.yml
+++ b/spec/rtems/config/if/get-stack-free-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the thread stack allocator free hook.
+ Gets the thread stack allocator free hook configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_stack_free_hook
-notes: null
+notes: |
+ See ${/acfg/if/task-stack-deallocator:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the thread stack allocator free hook configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-space-size.yml b/spec/rtems/config/if/get-stack-space-size.yml
index ea1aba2..30cfa17 100644
--- a/spec/rtems/config/if/get-stack-space-size.yml
+++ b/spec/rtems/config/if/get-stack-space-size.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the thread stack space size in bytes of configured for this
- application.
+ Gets the thread stack space size in bytes of configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -24,6 +23,8 @@ name: rtems_configuration_get_stack_space_size
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the thread stack space size in bytes of configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-ticks-per-timeslice.yml b/spec/rtems/config/if/get-ticks-per-timeslice.yml
index 1942fc3..fce4c2a 100644
--- a/spec/rtems/config/if/get-ticks-per-timeslice.yml
+++ b/spec/rtems/config/if/get-ticks-per-timeslice.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the clock ticks per timeslice configured for this application.
+ Gets the clock ticks per timeslice configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -16,9 +16,11 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_ticks_per_timeslice
-notes: null
+notes: |
+ See ${/acfg/if/ticks-per-time-slice:/name}.
params: []
return:
- return: null
+ return: |
+ Returns the clock ticks per timeslice configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-unified-work-area.yml b/spec/rtems/config/if/get-unified-work-area.yml
index e3b6eb0..e9a4db1 100644
--- a/spec/rtems/config/if/get-unified-work-area.yml
+++ b/spec/rtems/config/if/get-unified-work-area.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the RTEMS Workspace and C Program Heap are unified,
- otherwise returns false.
+ Indicates if the RTEMS Workspace and C Program Heap are configured to be
+ unified for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -17,9 +17,12 @@ links:
- role: interface-ingroup
uid: group
name: rtems_configuration_get_unified_work_area
-notes: null
+notes: |
+ See ${/acfg/if/unified-work-areas:/name}.
params: []
return:
- return: null
+ return: |
+ Returns true, if the RTEMS Workspace and C Program Heap are configured to
+ be unified for this application, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-user-extension-table.yml b/spec/rtems/config/if/get-user-extension-table.yml
index f063216..e077b21 100644
--- a/spec/rtems/config/if/get-user-extension-table.yml
+++ b/spec/rtems/config/if/get-user-extension-table.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the pointer to the initial extensions table configured for this
- application.
+ Gets the initial extensions table configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,6 +19,8 @@ name: rtems_configuration_get_user_extension_table
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the pointer to the initial extensions table configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-user-multiprocessing-table.yml b/spec/rtems/config/if/get-user-multiprocessing-table.yml
index 3068e9b..6f84cd2 100644
--- a/spec/rtems/config/if/get-user-multiprocessing-table.yml
+++ b/spec/rtems/config/if/get-user-multiprocessing-table.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the pointer to the MPCI configuration table configured for this
- application.
+ Gets the MPCI configuration table configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -22,6 +21,8 @@ name: rtems_configuration_get_user_multiprocessing_table
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the pointer to the MPCI configuration table configured for this
+ application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-version-string.yml b/spec/rtems/config/if/get-version-string.yml
index 7ede2d3..2c2f917 100644
--- a/spec/rtems/config/if/get-version-string.yml
+++ b/spec/rtems/config/if/get-version-string.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the pointer to the RTEMS version string.
+ Gets the RTEMS version string.
copyrights:
- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -23,6 +23,7 @@ name: rtems_get_version_string
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the pointer to the RTEMS version string.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-work-space-size.yml b/spec/rtems/config/if/get-work-space-size.yml
index a22cbe5..e402268 100644
--- a/spec/rtems/config/if/get-work-space-size.yml
+++ b/spec/rtems/config/if/get-work-space-size.yml
@@ -1,13 +1,13 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the RTEMS Workspace size in bytes configured for this application.
+ Gets the RTEMS Workspace size in bytes configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default: |
- (${/score/wkspace/if/size:/name} +
- (${get-stack-allocator-avoids-work-space:/name}() ?
- 0 : ${get-stack-space-size:/name}()))
+ ( ${/score/wkspace/if/size:/name} +
+ ( ${get-stack-allocator-avoids-work-space:/name}() ?
+ 0 : ${get-stack-space-size:/name}() ) )
variants: []
description: null
enabled-by: true
@@ -22,6 +22,7 @@ name: rtems_configuration_get_work_space_size
notes: null
params: []
return:
- return: null
+ return: |
+ Returns the RTEMS Workspace size in bytes configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/group.yml b/spec/rtems/config/if/group.yml
index 1107f55..dc1a543 100644
--- a/spec/rtems/config/if/group.yml
+++ b/spec/rtems/config/if/group.yml
@@ -1,10 +1,12 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This group contains defines and macros to create an application configuration
- as well as functions to get values of the application configuration.
+ The application configuration information group provides an API to get the
+ configuration of an application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+description: |
+ Some interfaces of this API are also used to define application configuration
+ option values, for example ${resource-unlimited:/name}.
enabled-by: true
identifier: RTEMSAPIConfig
index-entries: []
@@ -14,7 +16,8 @@ links:
uid: header
- role: interface-ingroup
uid: /if/api
-name: Application Configuration
+name: Application Configuration Information
text: |
- The API shall provide an interface to the application configuration.
+ The API shall provide an interface to get the configuration of an
+ application.
type: interface
diff --git a/spec/rtems/config/if/has-hardware-fp.yml b/spec/rtems/config/if/has-hardware-fp.yml
index 3d0cf57..97099bf 100644
--- a/spec/rtems/config/if/has-hardware-fp.yml
+++ b/spec/rtems/config/if/has-hardware-fp.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant evaluates to ${../../basedefs/if/true:/name}, if the this
- processor variant has hardware floating point support, otherwise evaluates to
+ This constant evaluates to ${../../basedefs/if/true:/name}, if this processor
+ variant has hardware floating point support, otherwise to
${../../basedefs/if/false:/name}.
copyrights:
- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/rtems/config/if/header-2.yml b/spec/rtems/config/if/header-2.yml
index e3b377f..672d1b4 100644
--- a/spec/rtems/config/if/header-2.yml
+++ b/spec/rtems/config/if/header-2.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This header file defines parts of the application configuration information
+ This header file provides parts of the application configuration information
API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/rtems/config/if/header.yml b/spec/rtems/config/if/header.yml
index a36751a..6023eb2 100644
--- a/spec/rtems/config/if/header.yml
+++ b/spec/rtems/config/if/header.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This header file defines parts of the application configuration information
+ This header file provides parts of the application configuration information
API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -19,6 +19,8 @@ links:
uid: header-2
- role: interface-placement
uid: /if/domain
+- role: interface-ingroup
+ uid: group
path: rtems/config.h
prefix: cpukit/include
type: interface
diff --git a/spec/rtems/config/if/resource-is-unlimited.yml b/spec/rtems/config/if/resource-is-unlimited.yml
index d0ded37..bde4703 100644
--- a/spec/rtems/config/if/resource-is-unlimited.yml
+++ b/spec/rtems/config/if/resource-is-unlimited.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the resource is unlimited, otherwise returns false.
+ Indicates if the resource is unlimited.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -24,6 +24,7 @@ params:
dir: null
name: _resource
return:
- return: null
+ return: |
+ Returns true, if the resource is unlimited, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/resource-maximum-per-allocation.yml b/spec/rtems/config/if/resource-maximum-per-allocation.yml
index 6579347..b595799 100644
--- a/spec/rtems/config/if/resource-maximum-per-allocation.yml
+++ b/spec/rtems/config/if/resource-maximum-per-allocation.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the maximum number per allocation of a resource number.
+ Gets the maximum number per allocation of a resource number.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -24,6 +24,7 @@ params:
dir: null
name: _resource
return:
- return: null
+ return: |
+ Returns the maximum number per allocation of a resource number.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/resource-unlimited.yml b/spec/rtems/config/if/resource-unlimited.yml
index 74f3c7d..dc7322a 100644
--- a/spec/rtems/config/if/resource-unlimited.yml
+++ b/spec/rtems/config/if/resource-unlimited.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the resource number configured for unlimited resources.
+ Augments the resource number so that it indicates an unlimited resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
- default: ((${.:/params[0]/name}) | ${unlimited-objects:/name})
+ default: ( (${.:/params[0]/name}) | ${unlimited-objects:/name} )
variants: []
description: null
enabled-by: true
@@ -20,10 +20,11 @@ notes: |
This function is implemented as a macro and can be used to define compile
time constants.
params:
-- description: is the resource number.
+- description: is the resource number to augment.
dir: null
name: _resource
return:
- return: null
+ return: |
+ Returns the resource number augmented to indicate an unlimited resource.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/stack-allocate-hook.yml b/spec/rtems/config/if/stack-allocate-hook.yml
index 9606f4c..e9c4539 100644
--- a/spec/rtems/config/if/stack-allocate-hook.yml
+++ b/spec/rtems/config/if/stack-allocate-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Thread stack allocator allocate handlers shall have this type.
+ A thread stack allocator allocate handler shall have this type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
diff --git a/spec/rtems/config/if/stack-allocate-init-hook.yml b/spec/rtems/config/if/stack-allocate-init-hook.yml
index 7f91b88..d6ee132 100644
--- a/spec/rtems/config/if/stack-allocate-init-hook.yml
+++ b/spec/rtems/config/if/stack-allocate-init-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Thread stack allocator initialization handlers shall have this type.
+ A thread stack allocator initialization handler shall have this type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
diff --git a/spec/rtems/config/if/stack-free-hook.yml b/spec/rtems/config/if/stack-free-hook.yml
index dd9aa2b..d31a2cf 100644
--- a/spec/rtems/config/if/stack-free-hook.yml
+++ b/spec/rtems/config/if/stack-free-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Thread stack allocator free handlers shall have this type.
+ A thread stack allocator free handler shall have this type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
diff --git a/spec/rtems/config/if/unlimited-objects.yml b/spec/rtems/config/if/unlimited-objects.yml
index 7f91a16..e821baf 100644
--- a/spec/rtems/config/if/unlimited-objects.yml
+++ b/spec/rtems/config/if/unlimited-objects.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This flag is used in resource numbers to indicate an unlimited resource.
+ This flag is used in augment a resource number so that it indicates an
+ unlimited resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
More information about the vc
mailing list