rtems-docs/c-user/partition/introduction.rst
Sebastian Huber 530bc2b0e3 c-user: Generate Partition Manager documentation
The manager documentation is a consolidation of the comments in Doxygen
markup and the documentation sources in Sphinx markup.  The
documentation was transfered to interface specification items.  This
header file was generated from the items by a script.

Update #3993.
2020-11-12 07:42:45 +01:00

46 lines
1.4 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://docs.rtems.org/branches/master/user/support/bugs.html
..
.. For information on updating and regenerating please refer to:
..
.. https://docs.rtems.org/branches/master/eng/req/howto.html
.. Generated from spec:/rtems/part/if/group
.. _PartitionManagerIntroduction:
Introduction
============
.. The following list was generated from:
.. spec:/rtems/part/if/create
.. spec:/rtems/part/if/ident
.. spec:/rtems/part/if/delete
.. spec:/rtems/part/if/get-buffer
.. spec:/rtems/part/if/return-buffer
The Partition Manager provides facilities to dynamically allocate memory in
fixed-size units. The directives provided by the Partition Manager are:
* :ref:`InterfaceRtemsPartitionCreate` - Creates a partition.
* :ref:`InterfaceRtemsPartitionIdent` - Identifies a partition by the object
name.
* :ref:`InterfaceRtemsPartitionDelete` - Deletes the partition.
* :ref:`InterfaceRtemsPartitionGetBuffer` - Tries to get a buffer from the
partition.
* :ref:`InterfaceRtemsPartitionReturnBuffer` - Returns the buffer to the
partition.