[rtems-docs commit] c-user: Document new linker set macros

[Sebastian Huber]

Module:    rtems-docs
Branch:    master
Commit:    a4b23d9ba8f4d927c7564da496a9bc4d897ca49f
Changeset: http://git.rtems.org/rtems-docs/commit/?id=a4b23d9ba8f4d927c7564da496a9bc4d897ca49f

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Feb  5 09:05:07 2020 +0100

c-user: Document new linker set macros

Adjust copyright.  Linker sets were introduced in 2015.

Update #2408.
Close #3865.

---

 c-user/index.rst       |  4 +--
 c-user/linker_sets.rst | 69 +++++++++++++++++++++++++++++++++++++++-----------
 2 files changed, 56 insertions(+), 17 deletions(-)

diff --git a/c-user/index.rst b/c-user/index.rst
index 1b6e096..30cd165 100644
--- a/c-user/index.rst
+++ b/c-user/index.rst
@@ -10,8 +10,8 @@ RTEMS Classic API Guide (|version|).
 
     | |copy| 2017 Chris Johns
     | |copy| 2017 Kuan-Hsun Chen
-    | |copy| 2016, 2018 embedded brains GmbH
-    | |copy| 2016, 2018 Sebastian Huber
+    | |copy| 2015, 2020 embedded brains GmbH
+    | |copy| 2015, 2020 Sebastian Huber
     | |copy| 2011 Petr Benes
     | |copy| 2010 Gedare Bloom
     | |copy| 1988, 2018 On-Line Applications Research Corporation (OAR)
diff --git a/c-user/linker_sets.rst b/c-user/linker_sets.rst
index f22c7bc..8ad4846 100644
--- a/c-user/linker_sets.rst
+++ b/c-user/linker_sets.rst
@@ -1,6 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
-.. Copyright (C) 1989, 2014 On-Line Applications Research Corporation (OAR)
+.. Copyright (C) 2015, 2020 embedded brains GmbH
+.. Copyright (C) 2015, 2020 Sebastian Huber
 
 .. index:: linkersets
 
@@ -41,6 +42,8 @@ The following macros are provided to create, populate and use linker sets.
 
 - RTEMS_LINKER_ROSET_ITEM_DECLARE_ - Declares a read-only linker set item
 
+- RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE_ - Declares an ordered read-only linker set item
+
 - RTEMS_LINKER_ROSET_ITEM_REFERENCE_ - References a read-only linker set item
 
 - RTEMS_LINKER_ROSET_ITEM_ - Defines a read-only linker set item
@@ -55,6 +58,8 @@ The following macros are provided to create, populate and use linker sets.
 
 - RTEMS_LINKER_RWSET_ITEM_DECLARE_ - Declares a read-write linker set item
 
+- RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE_ - Declares an ordered read-write linker set item
+
 - RTEMS_LINKER_RWSET_ITEM_REFERENCE_ - References a read-write linker set item
 
 - RTEMS_LINKER_RWSET_ITEM_ - Defines a read-write linker set item
@@ -346,13 +351,30 @@ CALLING SEQUENCE:
 
 DESCRIPTION:
     This macro generates a declaration of an item contained in the read-only
-    linker set identified by ``set``.  The ``set`` parameter itself must be a
-    valid C designator on which no macro expansion is performed.  It uniquely
-    identifies the linker set. The ``type`` parameter defines the type of the
-    linker set items.  The type must be the same for all macro invocations of a
-    particular linker set. The ``item`` parameter itself must be a valid C
-    designator on which no macro expansion is performed.  It uniquely
-    identifies an item in the linker set.
+    linker set identified by ``set``.  For a description of the ``set``,
+    ``type``, and ``item`` parameters see :ref:`RTEMS_LINKER_ROSET_ITEM`.
+
+.. raw:: latex
+
+   \clearpage
+
+.. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE
+
+.. _RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE:
+
+RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE - Declares an ordered read-only linker set item
+---------------------------------------------------------------------------------------
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE( set, type, item, order );
+
+DESCRIPTION:
+    This macro generates a declaration of an ordered item contained in the
+    read-only linker set identified by ``set``.  For a description of the
+    ``set``, ``type``, ``item``, and ``order`` parameters see
+    :ref:`RTEMS_LINKER_ROSET_ITEM_ORDERED`.
 
 .. raw:: latex
 
@@ -553,13 +575,30 @@ CALLING SEQUENCE:
 
 DESCRIPTION:
     This macro generates a declaration of an item contained in the read-write
-    linker set identified by ``set``.  The ``set`` parameter itself must be a
-    valid C designator on which no macro expansion is performed.  It uniquely
-    identifies the linker set. The ``type`` parameter defines the type of the
-    linker set items.  The type must be the same for all macro invocations of a
-    particular linker set. The ``item`` parameter itself must be a valid C
-    designator on which no macro expansion is performed.  It uniquely
-    identifies an item in the linker set.
+    linker set identified by ``set``.  For a description of the ``set``,
+    ``type``, and ``item`` parameters see :ref:`RTEMS_LINKER_RWSET_ITEM`.
+
+.. raw:: latex
+
+   \clearpage
+
+.. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE
+
+.. _RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE:
+
+RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE - Declares an ordered read-write linker set item
+----------------------------------------------------------------------------------------
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE( set, type, item, order );
+
+DESCRIPTION:
+    This macro generates a declaration of an ordered item contained in the
+    read-write linker set identified by ``set``.  For a description of the
+    ``set``, ``type``, ``item``, and ``order`` parameters see
+    :ref:`RTEMS_LINKER_RWSET_ITEM_ORDERED`.
 
 .. raw:: latex