Changeset 9628dfd in rtems-docs

Timestamp:

10/01/20 05:37:04 (3 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

master

Children:

d75b31f

Parents:

e70aebd

Message:

eng: Clarify stlib build attribute

Update #4107.

File:

• eng/req/items.rst (modified) (6 diffs)

eng/req/items.rst

@@ -280 +280 @@
 
 stlib
-    The attribute value shall be a list of strings. It shall be a list of
-    external static library identifiers used to link this test program, e.g.
-    ``m`` for ``libm.a``.
+    The attribute value shall be a list. Each list element shall be a
+    :ref:`SpecTypeBuildLinkStaticLibraryDirective`.
 
 target
@@ -822 +821 @@
 
 stlib
-    The attribute value shall be a list of strings. It shall be a list of
-    external static library identifiers used to link this test program, e.g.
-    ``m`` for ``libm.a``.
+    The attribute value shall be a list. Each list element shall be a
+    :ref:`SpecTypeBuildLinkStaticLibraryDirective`.
 
 use-after
@@ -955 +953 @@
 
 stlib
-    The attribute value shall be a list of strings. It shall be a list of
-    external static library identifiers used to link this test program, e.g.
-    ``m`` for ``libm.a``.
+    The attribute value shall be a list. Each list element shall be a
+    :ref:`SpecTypeBuildLinkStaticLibraryDirective`.
 
 target
@@ -2713 +2710 @@
 * :ref:`SpecTypeBuildStartFileItemType`
 
+.. _SpecTypeBuildLinkStaticLibraryDirective:
+
+Build Link Static Library Directive
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The value shall be a string. It shall be an external static library identifier.
+The library is used to link programs referenced by this item, e.g. ``m`` for
+``libm.a``.  The library is added to the build command through the ``stlib``
+attribute. It shall not be used for internal static libraries.  Internal static
+libraries shall be specified through the ``use-after`` and ``use-before``
+attributes to enable a proper build dependency tracking.
+
+This type is used by the following types:
+
+* :ref:`SpecTypeBuildAdaTestProgramItemType`
+
+* :ref:`SpecTypeBuildScriptItemType`
+
+* :ref:`SpecTypeBuildTestProgramItemType`
+
 .. _SpecTypeBuildLinkerOption:
 
@@ -3124 +3141 @@
 
 The value shall be a string. It shall be an internal static library identifier.
-They are used to link programs referenced by this item, e.g. ``z`` for
-``libz.a``.  They are placed after the use items of the build item context.
+The library is used to link programs referenced by this item, e.g. ``z`` for
+``libz.a``.  The library is placed after the use items of the build item
+context.
 
 This type is used by the following types:
@@ -3143 +3161 @@
 
 The value shall be a string. It shall be an internal static library identifier.
-They are used to link programs referenced by this item, e.g. ``z`` for
-``libz.a``.  They are placed before the use items of the build item context.
+The library is used to link programs referenced by this item, e.g. ``z`` for
+``libz.a``.  The library is placed before the use items of the build item
+context.
 
 This type is used by the following types: