From 540d24dded649f27415745361adc1111accd42d9 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 21 Apr 2021 13:23:10 +0200 Subject: spec: Add user extensions glossary terms --- spec-glossary/glossary/dynamic-extension-sets.yml | 15 +++++++++++++++ spec-glossary/glossary/extension-forward-order.yml | 19 +++++++++++++++++++ spec-glossary/glossary/extension-reverse-order.yml | 19 +++++++++++++++++++ spec-glossary/glossary/initial-extension-sets.yml | 16 ++++++++++++++++ spec-glossary/glossary/userextensions.yml | 8 ++++++-- 5 files changed, 75 insertions(+), 2 deletions(-) create mode 100644 spec-glossary/glossary/dynamic-extension-sets.yml create mode 100644 spec-glossary/glossary/extension-forward-order.yml create mode 100644 spec-glossary/glossary/extension-reverse-order.yml create mode 100644 spec-glossary/glossary/initial-extension-sets.yml diff --git a/spec-glossary/glossary/dynamic-extension-sets.yml b/spec-glossary/glossary/dynamic-extension-sets.yml new file mode 100644 index 00000000..955a2736 --- /dev/null +++ b/spec-glossary/glossary/dynamic-extension-sets.yml @@ -0,0 +1,15 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: term +links: +- role: glossary-member + uid: ../glossary-general +term: dynamic extension sets +text: | + The dynamic extension sets are a list of ${userextensions:/term}. The list + is defined by the system services used by the application and directive calls + such as ${/rtems/userext/if/create:/name}. See also + ${initial-extension-sets:/term}. +type: glossary diff --git a/spec-glossary/glossary/extension-forward-order.yml b/spec-glossary/glossary/extension-forward-order.yml new file mode 100644 index 00000000..e3ed5eb4 --- /dev/null +++ b/spec-glossary/glossary/extension-forward-order.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: term +links: +- role: glossary-member + uid: ../glossary-general +term: extension forward order +text: | + The ${userextensions:/term} may be invoked in extension forward order. In + forward order, all user extensions of the ${initial-extension-sets:/term} are + invoked before all user extensions of the ${dynamic-extension-sets:/term}. + In the initial extension sets the order is defined by the table index. The + user extension with the lowest table index is invoked first. In the dynamic + extension sets the order is defined by the registration order. The first + registered user extension is invoked first. See also + ${extension-reverse-order:/term}. +type: glossary diff --git a/spec-glossary/glossary/extension-reverse-order.yml b/spec-glossary/glossary/extension-reverse-order.yml new file mode 100644 index 00000000..b9ef5f5f --- /dev/null +++ b/spec-glossary/glossary/extension-reverse-order.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: term +links: +- role: glossary-member + uid: ../glossary-general +term: extension reverse order +text: | + The ${userextensions:/term} may be invoked in extension reverse order. In + reverse order, all user extensions of the ${dynamic-extension-sets:/term} are + invoked before all user extensions of the ${initial-extension-sets:/term}. + In the dynamic extension sets the order is defined by the registration order. + The last registered user extension is invoked first. In the initial + extension sets the order is defined by the table index. The user extension + with the highest table index is invoked first. See also + ${extension-forward-order:/term}. +type: glossary diff --git a/spec-glossary/glossary/initial-extension-sets.yml b/spec-glossary/glossary/initial-extension-sets.yml new file mode 100644 index 00000000..ea166da9 --- /dev/null +++ b/spec-glossary/glossary/initial-extension-sets.yml @@ -0,0 +1,16 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: term +links: +- role: glossary-member + uid: ../glossary-general +term: initial extension sets +text: | + The initial extension sets are a table of ${userextensions:/term}. The table + is defined by the application configuration for example through the + ${/acfg/if/initial-extensions:/name} application configuration option. The + initial extension sets cannot be altered during runtime through directive + calls. See also ${dynamic-extension-sets:/term}. +type: glossary diff --git a/spec-glossary/glossary/userextensions.yml b/spec-glossary/glossary/userextensions.yml index 2c16783b..50d59098 100644 --- a/spec-glossary/glossary/userextensions.yml +++ b/spec-glossary/glossary/userextensions.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 1998 On-Line Applications Research Corporation (OAR) enabled-by: true glossary-type: term @@ -8,6 +9,9 @@ links: uid: ../glossary-general term: user extensions text: | - Software routines provided by the application to enhance the - functionality of RTEMS. + User extensions are software routines provided by the application to enhance + the functionality of RTEMS. An active user extension is either in the + ${initial-extension-sets:/term} or the ${dynamic-extension-sets:/term}. User + extensions are invoked in ${extension-forward-order:/term} or + ${extension-reverse-order:/term}. type: glossary -- cgit v1.2.3