summaryrefslogtreecommitdiffstats
path: root/c-user/partition/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-10-12 15:53:05 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-12 07:42:45 +0100
commit530bc2b0e34cb0ba2624e59b5f08e951153282ae (patch)
treebc286d48a6275789d3ff3963b678904eaefd38b4 /c-user/partition/introduction.rst
parentc-user: Generate Event Manager documentation (diff)
downloadrtems-docs-530bc2b0e34cb0ba2624e59b5f08e951153282ae.tar.bz2
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.
Diffstat (limited to '')
-rw-r--r--c-user/partition/introduction.rst40
1 files changed, 33 insertions, 7 deletions
diff --git a/c-user/partition/introduction.rst b/c-user/partition/introduction.rst
index dd51d30..02ccf28 100644
--- a/c-user/partition/introduction.rst
+++ b/c-user/partition/introduction.rst
@@ -1,19 +1,45 @@
.. 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 partition manager provides facilities to dynamically allocate memory in
-fixed-size units. The directives provided by the partition manager are:
+.. 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:`rtems_partition_create`
+* :ref:`InterfaceRtemsPartitionCreate` - Creates a partition.
-- :ref:`rtems_partition_ident`
+* :ref:`InterfaceRtemsPartitionIdent` - Identifies a partition by the object
+ name.
-- :ref:`rtems_partition_delete`
+* :ref:`InterfaceRtemsPartitionDelete` - Deletes the partition.
-- :ref:`rtems_partition_get_buffer`
+* :ref:`InterfaceRtemsPartitionGetBuffer` - Tries to get a buffer from the
+ partition.
-- :ref:`rtems_partition_return_buffer`
+* :ref:`InterfaceRtemsPartitionReturnBuffer` - Returns the buffer to the
+ partition.