Changeset a4b23d9 in rtems-docs


Ignore:
Timestamp:
Feb 5, 2020, 8:05:07 AM (6 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
45a0f65
Parents:
df2dcdb
git-author:
Sebastian Huber <sebastian.huber@…> (02/05/20 08:05:07)
git-committer:
Sebastian Huber <sebastian.huber@…> (02/06/20 14:18:23)
Message:

c-user: Document new linker set macros

Adjust copyright. Linker sets were introduced in 2015.

Update #2408.
Close #3865.

Location:
c-user
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • c-user/index.rst

    rdf2dcdb ra4b23d9  
    1111    | |copy| 2017 Chris Johns
    1212    | |copy| 2017 Kuan-Hsun Chen
    13     | |copy| 2016, 2018 embedded brains GmbH
    14     | |copy| 2016, 2018 Sebastian Huber
     13    | |copy| 2015, 2020 embedded brains GmbH
     14    | |copy| 2015, 2020 Sebastian Huber
    1515    | |copy| 2011 Petr Benes
    1616    | |copy| 2010 Gedare Bloom
  • c-user/linker_sets.rst

    rdf2dcdb ra4b23d9  
    11.. SPDX-License-Identifier: CC-BY-SA-4.0
    22
    3 .. Copyright (C) 1989, 2014 On-Line Applications Research Corporation (OAR)
     3.. Copyright (C) 2015, 2020 embedded brains GmbH
     4.. Copyright (C) 2015, 2020 Sebastian Huber
    45
    56.. index:: linkersets
     
    4243- RTEMS_LINKER_ROSET_ITEM_DECLARE_ - Declares a read-only linker set item
    4344
     45- RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE_ - Declares an ordered read-only linker set item
     46
    4447- RTEMS_LINKER_ROSET_ITEM_REFERENCE_ - References a read-only linker set item
    4548
     
    5558
    5659- RTEMS_LINKER_RWSET_ITEM_DECLARE_ - Declares a read-write linker set item
     60
     61- RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE_ - Declares an ordered read-write linker set item
    5762
    5863- RTEMS_LINKER_RWSET_ITEM_REFERENCE_ - References a read-write linker set item
     
    347352DESCRIPTION:
    348353    This macro generates a declaration of an item contained in the read-only
    349     linker set identified by ``set``.  The ``set`` parameter itself must be a
    350     valid C designator on which no macro expansion is performed.  It uniquely
    351     identifies the linker set. The ``type`` parameter defines the type of the
    352     linker set items.  The type must be the same for all macro invocations of a
    353     particular linker set. The ``item`` parameter itself must be a valid C
    354     designator on which no macro expansion is performed.  It uniquely
    355     identifies an item in the linker set.
     354    linker set identified by ``set``.  For a description of the ``set``,
     355    ``type``, and ``item`` parameters see :ref:`RTEMS_LINKER_ROSET_ITEM`.
     356
     357.. raw:: latex
     358
     359   \clearpage
     360
     361.. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE
     362
     363.. _RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE:
     364
     365RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE - Declares an ordered read-only linker set item
     366---------------------------------------------------------------------------------------
     367
     368CALLING SEQUENCE:
     369    .. code-block:: c
     370
     371        RTEMS_LINKER_ROSET_ITEM_ORDERED_DECLARE( set, type, item, order );
     372
     373DESCRIPTION:
     374    This macro generates a declaration of an ordered item contained in the
     375    read-only linker set identified by ``set``.  For a description of the
     376    ``set``, ``type``, ``item``, and ``order`` parameters see
     377    :ref:`RTEMS_LINKER_ROSET_ITEM_ORDERED`.
    356378
    357379.. raw:: latex
     
    554576DESCRIPTION:
    555577    This macro generates a declaration of an item contained in the read-write
    556     linker set identified by ``set``.  The ``set`` parameter itself must be a
    557     valid C designator on which no macro expansion is performed.  It uniquely
    558     identifies the linker set. The ``type`` parameter defines the type of the
    559     linker set items.  The type must be the same for all macro invocations of a
    560     particular linker set. The ``item`` parameter itself must be a valid C
    561     designator on which no macro expansion is performed.  It uniquely
    562     identifies an item in the linker set.
     578    linker set identified by ``set``.  For a description of the ``set``,
     579    ``type``, and ``item`` parameters see :ref:`RTEMS_LINKER_RWSET_ITEM`.
     580
     581.. raw:: latex
     582
     583   \clearpage
     584
     585.. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE
     586
     587.. _RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE:
     588
     589RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE - Declares an ordered read-write linker set item
     590----------------------------------------------------------------------------------------
     591
     592CALLING SEQUENCE:
     593    .. code-block:: c
     594
     595        RTEMS_LINKER_RWSET_ITEM_ORDERED_DECLARE( set, type, item, order );
     596
     597DESCRIPTION:
     598    This macro generates a declaration of an ordered item contained in the
     599    read-write linker set identified by ``set``.  For a description of the
     600    ``set``, ``type``, ``item``, and ``order`` parameters see
     601    :ref:`RTEMS_LINKER_RWSET_ITEM_ORDERED`.
    563602
    564603.. raw:: latex
Note: See TracChangeset for help on using the changeset viewer.