summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-24 12:25:31 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-24 12:25:31 +0200
commit4ad78f2e66e79bcc4d46d71af79a59a2314bb713 (patch)
tree521a3e074fa03ddfb9bea789358715c5a0ba169f
parent0e38d6d2b447ea4c7c1fc8df79aa6989d2fb62d1 (diff)
spec: Add header file brief descriptions
-rw-r--r--rtemsspec/interface.py1
-rw-r--r--rtemsspec/tests/spec-interface/h.yml1
-rw-r--r--rtemsspec/tests/spec-interface/h2.yml1
-rw-r--r--rtemsspec/tests/spec-interface/h3.yml1
-rw-r--r--rtemsspec/tests/spec-interface/h4.yml1
-rw-r--r--rtemsspec/tests/spec-interface/math.yml1
-rw-r--r--rtemsspec/tests/spec-interface/stdint.yml1
-rw-r--r--rtemsspec/tests/test_interface.py2
-rw-r--r--spec/if/build-options/cpuopts.yml1
-rw-r--r--spec/if/c/stdatomic.yml1
-rw-r--r--spec/if/c/stdbool.yml1
-rw-r--r--spec/if/c/stddef.yml1
-rw-r--r--spec/if/c/stdint.yml1
-rw-r--r--spec/if/c/string.yml1
-rw-r--r--spec/if/c/sys-cpuset.yml1
-rw-r--r--spec/if/c/sys-impl-timespec.yml1
-rw-r--r--spec/if/c/sys-impl-timeval.yml1
-rw-r--r--spec/if/c/sys-types.yml1
-rw-r--r--spec/if/c/time.yml1
-rw-r--r--spec/if/impl/cpu/header.yml1
-rw-r--r--spec/if/impl/heap/header.yml3
-rw-r--r--spec/if/impl/interr/header.yml1
-rw-r--r--spec/if/impl/isr/header-2.yml1
-rw-r--r--spec/if/impl/isr/header-3.yml1
-rw-r--r--spec/if/impl/isr/header.yml1
-rw-r--r--spec/if/impl/memory/header.yml1
-rw-r--r--spec/if/impl/mpci/header-2.yml1
-rw-r--r--spec/if/impl/mpci/header.yml1
-rw-r--r--spec/if/impl/object/header.yml1
-rw-r--r--spec/if/impl/smp/header-2.yml1
-rw-r--r--spec/if/impl/smp/header.yml1
-rw-r--r--spec/if/impl/stack/header.yml1
-rw-r--r--spec/if/impl/thread/header.yml4
-rw-r--r--spec/if/impl/userext/header.yml3
-rw-r--r--spec/if/impl/watchdog/header.yml4
-rw-r--r--spec/if/impl/wkspace/header.yml3
-rw-r--r--spec/if/rtems/attr/header.yml1
-rw-r--r--spec/if/rtems/barrier/header.yml1
-rw-r--r--spec/if/rtems/basedefs/header.yml3
-rw-r--r--spec/if/rtems/cache/header.yml1
-rw-r--r--spec/if/rtems/clock/header.yml1
-rw-r--r--spec/if/rtems/config/header-2.yml3
-rw-r--r--spec/if/rtems/config/header.yml3
-rw-r--r--spec/if/rtems/dpmem/header.yml1
-rw-r--r--spec/if/rtems/event/header.yml1
-rw-r--r--spec/if/rtems/fatal/header.yml1
-rw-r--r--spec/if/rtems/header.yml1
-rw-r--r--spec/if/rtems/init/header.yml1
-rw-r--r--spec/if/rtems/intr/header.yml1
-rw-r--r--spec/if/rtems/io/header.yml1
-rw-r--r--spec/if/rtems/message/header.yml1
-rw-r--r--spec/if/rtems/modes/header.yml1
-rw-r--r--spec/if/rtems/mp/header.yml1
-rw-r--r--spec/if/rtems/object/header.yml1
-rw-r--r--spec/if/rtems/options/header.yml1
-rw-r--r--spec/if/rtems/part/header.yml1
-rw-r--r--spec/if/rtems/ratemon/header.yml1
-rw-r--r--spec/if/rtems/region/header.yml1
-rw-r--r--spec/if/rtems/sem/header.yml1
-rw-r--r--spec/if/rtems/signal/header-2.yml1
-rw-r--r--spec/if/rtems/signal/header.yml1
-rw-r--r--spec/if/rtems/status/header.yml1
-rw-r--r--spec/if/rtems/support/header.yml1
-rw-r--r--spec/if/rtems/tasks/header.yml1
-rw-r--r--spec/if/rtems/timer/header.yml1
-rw-r--r--spec/if/rtems/types/header.yml1
-rw-r--r--spec/if/rtems/userext/header.yml1
-rw-r--r--spec/spec/interface-header-file.yml4
68 files changed, 90 insertions, 0 deletions
diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py
index 13cab4b6..09325f22 100644
--- a/rtemsspec/interface.py
+++ b/rtemsspec/interface.py
@@ -513,6 +513,7 @@ class _HeaderFile:
self._content.prepend_spdx_license_identifier()
with self._content.file_block():
self._content.add_ingroup(_get_group_identifiers(self._ingroups))
+ self._content.add_brief_description(self._item["brief"])
self._content.add_copyrights_and_licenses()
with self._content.header_guard(self._item["path"]):
exp_mapper = _HeaderExpressionMapper(self._item,
diff --git a/rtemsspec/tests/spec-interface/h.yml b/rtemsspec/tests/spec-interface/h.yml
index 0733837a..55485b60 100644
--- a/rtemsspec/tests/spec-interface/h.yml
+++ b/rtemsspec/tests/spec-interface/h.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: []
diff --git a/rtemsspec/tests/spec-interface/h2.yml b/rtemsspec/tests/spec-interface/h2.yml
index 194e182e..088e5216 100644
--- a/rtemsspec/tests/spec-interface/h2.yml
+++ b/rtemsspec/tests/spec-interface/h2.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by:
diff --git a/rtemsspec/tests/spec-interface/h3.yml b/rtemsspec/tests/spec-interface/h3.yml
index fc61a1a5..cf758f55 100644
--- a/rtemsspec/tests/spec-interface/h3.yml
+++ b/rtemsspec/tests/spec-interface/h3.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/rtemsspec/tests/spec-interface/h4.yml b/rtemsspec/tests/spec-interface/h4.yml
index 6233efe5..2e86aa80 100644
--- a/rtemsspec/tests/spec-interface/h4.yml
+++ b/rtemsspec/tests/spec-interface/h4.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/rtemsspec/tests/spec-interface/math.yml b/rtemsspec/tests/spec-interface/math.yml
index 020449fa..1d545415 100644
--- a/rtemsspec/tests/spec-interface/math.yml
+++ b/rtemsspec/tests/spec-interface/math.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/rtemsspec/tests/spec-interface/stdint.yml b/rtemsspec/tests/spec-interface/stdint.yml
index 559202c3..3482c710 100644
--- a/rtemsspec/tests/spec-interface/stdint.yml
+++ b/rtemsspec/tests/spec-interface/stdint.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines X.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py
index c6aa625b..a08c5213 100644
--- a/rtemsspec/tests/test_interface.py
+++ b/rtemsspec/tests/test_interface.py
@@ -56,6 +56,8 @@ def test_interface(tmpdir):
* @ingroup GroupA
* @ingroup GroupB
* @ingroup GroupC
+ *
+ * @brief This header file defines X.
*/
/*
diff --git a/spec/if/build-options/cpuopts.yml b/spec/if/build-options/cpuopts.yml
index 599881ce..803c28e6 100644
--- a/spec/if/build-options/cpuopts.yml
+++ b/spec/if/build-options/cpuopts.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces provided by the CPU build options.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/stdatomic.yml b/spec/if/c/stdatomic.yml
index 51cd368d..7ff24fc1 100644
--- a/spec/if/c/stdatomic.yml
+++ b/spec/if/c/stdatomic.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/stdbool.yml b/spec/if/c/stdbool.yml
index ec8bae06..8adbb490 100644
--- a/spec/if/c/stdbool.yml
+++ b/spec/if/c/stdbool.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/stddef.yml b/spec/if/c/stddef.yml
index 9e07ec76..0903df33 100644
--- a/spec/if/c/stddef.yml
+++ b/spec/if/c/stddef.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/stdint.yml b/spec/if/c/stdint.yml
index 1cbb808f..6322d4e7 100644
--- a/spec/if/c/stdint.yml
+++ b/spec/if/c/stdint.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/string.yml b/spec/if/c/string.yml
index 0dc3dcf7..2b3fbbee 100644
--- a/spec/if/c/string.yml
+++ b/spec/if/c/string.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/sys-cpuset.yml b/spec/if/c/sys-cpuset.yml
index 1092d4c6..de6f3d78 100644
--- a/spec/if/c/sys-cpuset.yml
+++ b/spec/if/c/sys-cpuset.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is FreeBSD defined header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/sys-impl-timespec.yml b/spec/if/c/sys-impl-timespec.yml
index 7ecf5ae8..e8d4e621 100644
--- a/spec/if/c/sys-impl-timespec.yml
+++ b/spec/if/c/sys-impl-timespec.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file provides POSIX time related definitions.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/sys-impl-timeval.yml b/spec/if/c/sys-impl-timeval.yml
index 9a24dbf3..c77cea75 100644
--- a/spec/if/c/sys-impl-timeval.yml
+++ b/spec/if/c/sys-impl-timeval.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file provides POSIX time related definitions.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/sys-types.yml b/spec/if/c/sys-types.yml
index 012db722..18df5dc8 100644
--- a/spec/if/c/sys-types.yml
+++ b/spec/if/c/sys-types.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is POSIX header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/c/time.yml b/spec/if/c/time.yml
index 67389bb1..1d2c39f4 100644
--- a/spec/if/c/time.yml
+++ b/spec/if/c/time.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This is a standard C library header file.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/cpu/header.yml b/spec/if/impl/cpu/header.yml
index 6cc37192..8c52a9c6 100644
--- a/spec/if/impl/cpu/header.yml
+++ b/spec/if/impl/cpu/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the CPU port.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/heap/header.yml b/spec/if/impl/heap/header.yml
index 99e90741..84acf0c4 100644
--- a/spec/if/impl/heap/header.yml
+++ b/spec/if/impl/heap/header.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines interfaces of the Heap Handler which provide
+ information of a heap.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/interr/header.yml b/spec/if/impl/interr/header.yml
index 915d487d..8c0255e2 100644
--- a/spec/if/impl/interr/header.yml
+++ b/spec/if/impl/interr/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the interfaces of the Fatal Error Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/isr/header-2.yml b/spec/if/impl/isr/header-2.yml
index 04b440b2..6aedaf66 100644
--- a/spec/if/impl/isr/header-2.yml
+++ b/spec/if/impl/isr/header-2.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces related to the ISR level.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/isr/header-3.yml b/spec/if/impl/isr/header-3.yml
index 13d86502..6bcf1270 100644
--- a/spec/if/impl/isr/header-3.yml
+++ b/spec/if/impl/isr/header-3.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the ISR Lock Handler
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/isr/header.yml b/spec/if/impl/isr/header.yml
index c2af6a0c..0323b435 100644
--- a/spec/if/impl/isr/header.yml
+++ b/spec/if/impl/isr/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the ISR Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/memory/header.yml b/spec/if/impl/memory/header.yml
index 090fd915..4b35d99a 100644
--- a/spec/if/impl/memory/header.yml
+++ b/spec/if/impl/memory/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the Memory Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/mpci/header-2.yml b/spec/if/impl/mpci/header-2.yml
index 5087d694..56470b31 100644
--- a/spec/if/impl/mpci/header-2.yml
+++ b/spec/if/impl/mpci/header-2.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the MPCI packet interfaces.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/mpci/header.yml b/spec/if/impl/mpci/header.yml
index 724493a0..b959193f 100644
--- a/spec/if/impl/mpci/header.yml
+++ b/spec/if/impl/mpci/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the interface of the MPCI implementation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/object/header.yml b/spec/if/impl/object/header.yml
index 2f5b95e8..8a1c69a3 100644
--- a/spec/if/impl/object/header.yml
+++ b/spec/if/impl/object/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the Object Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/smp/header-2.yml b/spec/if/impl/smp/header-2.yml
index bca78650..4cf217a0 100644
--- a/spec/if/impl/smp/header-2.yml
+++ b/spec/if/impl/smp/header-2.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the SMP Lock Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/smp/header.yml b/spec/if/impl/smp/header.yml
index a84ccb01..d7952c0e 100644
--- a/spec/if/impl/smp/header.yml
+++ b/spec/if/impl/smp/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the SMP Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/stack/header.yml b/spec/if/impl/stack/header.yml
index 17fa086d..92b9ff03 100644
--- a/spec/if/impl/stack/header.yml
+++ b/spec/if/impl/stack/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines interfaces of the Stack Handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/thread/header.yml b/spec/if/impl/thread/header.yml
index 744b844f..70655c43 100644
--- a/spec/if/impl/thread/header.yml
+++ b/spec/if/impl/thread/header.yml
@@ -1,4 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines data structures of the Thread Handler used to
+ instantiate idle thread related objects defined by the application
+ configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/userext/header.yml b/spec/if/impl/userext/header.yml
index 6c046dfc..a44dd92c 100644
--- a/spec/if/impl/userext/header.yml
+++ b/spec/if/impl/userext/header.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines data structures of the User Extensions Handler used
+ to instantiate objects defined by the application configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/watchdog/header.yml b/spec/if/impl/watchdog/header.yml
index 1fe027f9..39aa67df 100644
--- a/spec/if/impl/watchdog/header.yml
+++ b/spec/if/impl/watchdog/header.yml
@@ -1,4 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines data structures of the Watchdog Handler used to
+ instantiate clock tick related objects defined by the application
+ configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/impl/wkspace/header.yml b/spec/if/impl/wkspace/header.yml
index 33655aa4..f0e2f577 100644
--- a/spec/if/impl/wkspace/header.yml
+++ b/spec/if/impl/wkspace/header.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines data structures of the Workspace Handler used to
+ instantiate objects defined by the application configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/attr/header.yml b/spec/if/rtems/attr/header.yml
index 06680c9f..1ef0839a 100644
--- a/spec/if/rtems/attr/header.yml
+++ b/spec/if/rtems/attr/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines attributes provided by the API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/barrier/header.yml b/spec/if/rtems/barrier/header.yml
index 4bc5040b..fc76a102 100644
--- a/spec/if/rtems/barrier/header.yml
+++ b/spec/if/rtems/barrier/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Barrier Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/basedefs/header.yml b/spec/if/rtems/basedefs/header.yml
index 6d5c5d26..0fe9a823 100644
--- a/spec/if/rtems/basedefs/header.yml
+++ b/spec/if/rtems/basedefs/header.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file provides basic definitions used by the API and
+ the implementation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/cache/header.yml b/spec/if/rtems/cache/header.yml
index ae962263..e84b4f5e 100644
--- a/spec/if/rtems/cache/header.yml
+++ b/spec/if/rtems/cache/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Cache Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/clock/header.yml b/spec/if/rtems/clock/header.yml
index 1ef5b5c3..f402e692 100644
--- a/spec/if/rtems/clock/header.yml
+++ b/spec/if/rtems/clock/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Clock Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/config/header-2.yml b/spec/if/rtems/config/header-2.yml
index b06134c2..99bebfc7 100644
--- a/spec/if/rtems/config/header-2.yml
+++ b/spec/if/rtems/config/header-2.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines parts of the application configuration information
+ API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/config/header.yml b/spec/if/rtems/config/header.yml
index 0aef288f..dcaddd45 100644
--- a/spec/if/rtems/config/header.yml
+++ b/spec/if/rtems/config/header.yml
@@ -1,4 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines parts of the application configuration information
+ API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/dpmem/header.yml b/spec/if/rtems/dpmem/header.yml
index 9df2a09a..5aa6b51a 100644
--- a/spec/if/rtems/dpmem/header.yml
+++ b/spec/if/rtems/dpmem/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Dual-Ported Memory Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/event/header.yml b/spec/if/rtems/event/header.yml
index 3a4f1e81..eff99c1d 100644
--- a/spec/if/rtems/event/header.yml
+++ b/spec/if/rtems/event/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Event Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/fatal/header.yml b/spec/if/rtems/fatal/header.yml
index 28c2a03e..6fbe3be5 100644
--- a/spec/if/rtems/fatal/header.yml
+++ b/spec/if/rtems/fatal/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Fatal Error Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/header.yml b/spec/if/rtems/header.yml
index ade7cbac..2ce3fbd9 100644
--- a/spec/if/rtems/header.yml
+++ b/spec/if/rtems/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Classic API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml
index 7ddadca7..b2228785 100644
--- a/spec/if/rtems/init/header.yml
+++ b/spec/if/rtems/init/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Initialization Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/intr/header.yml b/spec/if/rtems/intr/header.yml
index 04de993a..1a3e0755 100644
--- a/spec/if/rtems/intr/header.yml
+++ b/spec/if/rtems/intr/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Interrupt Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/io/header.yml b/spec/if/rtems/io/header.yml
index 18bea8e2..c8175914 100644
--- a/spec/if/rtems/io/header.yml
+++ b/spec/if/rtems/io/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the IO Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/message/header.yml b/spec/if/rtems/message/header.yml
index 7b11b999..2dba7f70 100644
--- a/spec/if/rtems/message/header.yml
+++ b/spec/if/rtems/message/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Message Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/modes/header.yml b/spec/if/rtems/modes/header.yml
index 1cd9e781..e6e694d8 100644
--- a/spec/if/rtems/modes/header.yml
+++ b/spec/if/rtems/modes/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the task modes of the Task Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/mp/header.yml b/spec/if/rtems/mp/header.yml
index 1555c51f..95a9b92f 100644
--- a/spec/if/rtems/mp/header.yml
+++ b/spec/if/rtems/mp/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Multiprocessing Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/object/header.yml b/spec/if/rtems/object/header.yml
index 09d82dcb..8b90b787 100644
--- a/spec/if/rtems/object/header.yml
+++ b/spec/if/rtems/object/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Object Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/options/header.yml b/spec/if/rtems/options/header.yml
index 7a697a16..93c7087f 100644
--- a/spec/if/rtems/options/header.yml
+++ b/spec/if/rtems/options/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines options provided by the API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/part/header.yml b/spec/if/rtems/part/header.yml
index 52671a7d..8bd8a5f4 100644
--- a/spec/if/rtems/part/header.yml
+++ b/spec/if/rtems/part/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Partition Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/ratemon/header.yml b/spec/if/rtems/ratemon/header.yml
index dc566451..f6d0236f 100644
--- a/spec/if/rtems/ratemon/header.yml
+++ b/spec/if/rtems/ratemon/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Rate-Monotonic Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/region/header.yml b/spec/if/rtems/region/header.yml
index 06949537..0463cc18 100644
--- a/spec/if/rtems/region/header.yml
+++ b/spec/if/rtems/region/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Region Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/sem/header.yml b/spec/if/rtems/sem/header.yml
index 65be6db2..1e7c2c9b 100644
--- a/spec/if/rtems/sem/header.yml
+++ b/spec/if/rtems/sem/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Semaphore Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/signal/header-2.yml b/spec/if/rtems/signal/header-2.yml
index 59c98296..6e6a854f 100644
--- a/spec/if/rtems/signal/header-2.yml
+++ b/spec/if/rtems/signal/header-2.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the parts of the Signal Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/signal/header.yml b/spec/if/rtems/signal/header.yml
index c1c3f0c8..4f2ca30c 100644
--- a/spec/if/rtems/signal/header.yml
+++ b/spec/if/rtems/signal/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the parts of the Signal Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/status/header.yml b/spec/if/rtems/status/header.yml
index 63610f04..83cb2b38 100644
--- a/spec/if/rtems/status/header.yml
+++ b/spec/if/rtems/status/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the status codes provided by API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/support/header.yml b/spec/if/rtems/support/header.yml
index 5bdd2dcb..f21a705c 100644
--- a/spec/if/rtems/support/header.yml
+++ b/spec/if/rtems/support/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines support services of the API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/tasks/header.yml b/spec/if/rtems/tasks/header.yml
index ff75781a..2f0d15b5 100644
--- a/spec/if/rtems/tasks/header.yml
+++ b/spec/if/rtems/tasks/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the main parts of the Tasks Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/timer/header.yml b/spec/if/rtems/timer/header.yml
index 0200be2e..aee0329a 100644
--- a/spec/if/rtems/timer/header.yml
+++ b/spec/if/rtems/timer/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Timer Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/types/header.yml b/spec/if/rtems/types/header.yml
index 9f00af97..3a6774a1 100644
--- a/spec/if/rtems/types/header.yml
+++ b/spec/if/rtems/types/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines types provided by the API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/if/rtems/userext/header.yml b/spec/if/rtems/userext/header.yml
index eb68a9a1..f0d29cfa 100644
--- a/spec/if/rtems/userext/header.yml
+++ b/spec/if/rtems/userext/header.yml
@@ -1,4 +1,5 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the User Extensions Manager API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/spec/interface-header-file.yml b/spec/spec/interface-header-file.yml
index d6b10e89..1faae922 100644
--- a/spec/spec/interface-header-file.yml
+++ b/spec/spec/interface-header-file.yml
@@ -14,6 +14,10 @@ spec-example: null
spec-info:
dict:
attributes:
+ brief:
+ description: |
+ It shall be the brief description of the header file.
+ spec-type: str
path:
description: |
It shall be the path used to include the header file. For example