Changeset 4ad78f2 in rtems-central


Ignore:
Timestamp:
Jul 24, 2020, 10:25:31 AM (2 weeks ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
cead53e
Parents:
0e38d6d
Message:

spec: Add header file brief descriptions

Files:
68 edited

Legend:

Unmodified
Added
Removed
  • rtemsspec/interface.py

    r0e38d6d r4ad78f2  
    514514        with self._content.file_block():
    515515            self._content.add_ingroup(_get_group_identifiers(self._ingroups))
     516            self._content.add_brief_description(self._item["brief"])
    516517        self._content.add_copyrights_and_licenses()
    517518        with self._content.header_guard(self._item["path"]):
  • rtemsspec/tests/spec-interface/h.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/spec-interface/h2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/spec-interface/h3.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/spec-interface/h4.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/spec-interface/math.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/spec-interface/stdint.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines X.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • rtemsspec/tests/test_interface.py

    r0e38d6d r4ad78f2  
    5757 * @ingroup GroupB
    5858 * @ingroup GroupC
     59 *
     60 * @brief This header file defines X.
    5961 */
    6062
  • spec/if/build-options/cpuopts.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces provided by the CPU build options.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/stdatomic.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/stdbool.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/stddef.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/stdint.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/string.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/sys-cpuset.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is FreeBSD defined header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/sys-impl-timespec.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file provides POSIX time related definitions.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/sys-impl-timeval.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file provides POSIX time related definitions.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/sys-types.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is POSIX header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/c/time.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This is a standard C library header file.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/cpu/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the CPU port.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/heap/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines interfaces of the Heap Handler which provide
     4  information of a heap.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/interr/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the interfaces of the Fatal Error Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/isr/header-2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces related to the ISR level.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/isr/header-3.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the ISR Lock Handler
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/isr/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the ISR Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/memory/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the Memory Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/mpci/header-2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the MPCI packet interfaces.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/mpci/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the interface of the MPCI implementation.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/object/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the Object Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/smp/header-2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the SMP Lock Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/smp/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the SMP Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/stack/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines interfaces of the Stack Handler.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/thread/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines data structures of the Thread Handler used to
     4  instantiate idle thread related objects defined by the application
     5  configuration.
    26copyrights:
    37- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/userext/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines data structures of the User Extensions Handler used
     4  to instantiate objects defined by the application configuration.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/watchdog/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines data structures of the Watchdog Handler used to
     4  instantiate clock tick related objects defined by the application
     5  configuration.
    26copyrights:
    37- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/impl/wkspace/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines data structures of the Workspace Handler used to
     4  instantiate objects defined by the application configuration.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/attr/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines attributes provided by the API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/barrier/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Barrier Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/basedefs/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file provides basic definitions used by the API and
     4  the implementation.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/cache/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Cache Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/clock/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Clock Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/config/header-2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines parts of the application configuration information
     4  API.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/config/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: |
     3  This header file defines parts of the application configuration information
     4  API.
    25copyrights:
    36- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/dpmem/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Dual-Ported Memory Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/event/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Event Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/fatal/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Fatal Error Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Classic API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/init/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Initialization Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/intr/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Interrupt Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/io/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the IO Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/message/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Message Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/modes/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the task modes of the Task Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/mp/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Multiprocessing Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/object/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Object Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/options/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines options provided by the API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/part/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Partition Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/ratemon/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Rate-Monotonic Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/region/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Region Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/sem/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Semaphore Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/signal/header-2.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the parts of the Signal Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/signal/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the parts of the Signal Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/status/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the status codes provided by API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/support/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines support services of the API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/tasks/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the main parts of the Tasks Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/timer/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the Timer Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/types/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines types provided by the API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/if/rtems/userext/header.yml

    r0e38d6d r4ad78f2  
    11SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2brief: This header file defines the User Extensions Manager API.
    23copyrights:
    34- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
  • spec/spec/interface-header-file.yml

    r0e38d6d r4ad78f2  
    1515  dict:
    1616    attributes:
     17      brief:
     18        description: |
     19          It shall be the brief description of the header file.
     20        spec-type: str
    1721      path:
    1822        description: |
Note: See TracChangeset for help on using the changeset viewer.