[rtems-docs commit] eng: Add unspecified header file item type
Sebastian Huber
sebh at rtems.org
Fri May 19 05:21:25 UTC 2023
Module: rtems-docs
Branch: master
Commit: 9c2498a728370d395ce7fc22ce58a79008297b3e
Changeset: http://git.rtems.org/rtems-docs/commit/?id=9c2498a728370d395ce7fc22ce58a79008297b3e
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue May 9 13:59:28 2023 +0200
eng: Add unspecified header file item type
Update #3715.
---
eng/req/items.rst | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/eng/req/items.rst b/eng/req/items.rst
index 783800f..cdec0db 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -95,6 +95,8 @@ The specification item types have the following hierarchy:
* :ref:`SpecTypeInterfaceTypedefItemType`
+ * :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType`
+
* :ref:`SpecTypeInterfaceUnspecifiedItemType`
* :ref:`SpecTypeInterfaceVariableItemType`
@@ -1155,6 +1157,8 @@ This type is refined by the following types:
* :ref:`SpecTypeInterfaceTypedefItemType`
+* :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType`
+
* :ref:`SpecTypeInterfaceUnspecifiedItemType`
* :ref:`SpecTypeInterfaceVariableItemType`
@@ -1530,6 +1534,24 @@ params
return
The attribute value shall be an :ref:`SpecTypeInterfaceReturnDirective`.
+.. _SpecTypeInterfaceUnspecifiedHeaderFileItemType:
+
+Interface Unspecified Header File Item Type
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This type refines the :ref:`SpecTypeInterfaceItemType` through the
+``interface-type`` attribute if the value is ``unspecified-header-file``. This
+set of attributes specifies an unspecified header file. All explicit attributes
+shall be specified. The explicit attributes for this type are:
+
+path
+ The attribute value shall be a string. It shall be the path used to include
+ the header file. For example :file:`rtems/confdefs.h`.
+
+references
+ The attribute value shall be a list. Each list element shall be an
+ :ref:`SpecTypeExternalReference`.
+
.. _SpecTypeInterfaceUnspecifiedItemType:
Interface Unspecified Item Type
@@ -3815,6 +3837,8 @@ This type is refined by the following types:
This type is used by the following types:
+* :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType`
+
* :ref:`SpecTypeInterfaceUnspecifiedItemType`
* :ref:`SpecTypeRequirementItemType`
More information about the vc
mailing list