summaryrefslogtreecommitdiffstats
path: root/c-user/region/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-20 10:06:42 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-02 17:57:10 +0200
commitaebb6fd7c7abd598d803ca0b8013e2761633f03a (patch)
treef03ca76d0b69ac932b19fd779d6b2afe065aa9cd /c-user/region/introduction.rst
parentc-user: Split up rate-monotonic manager (diff)
downloadrtems-docs-aebb6fd7c7abd598d803ca0b8013e2761633f03a.tar.bz2
c-user: Split up region manager
This makes it easier to automatically generate parts of the manager documentation in the future. Update #3993.
Diffstat (limited to 'c-user/region/introduction.rst')
-rw-r--r--c-user/region/introduction.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/c-user/region/introduction.rst b/c-user/region/introduction.rst
new file mode 100644
index 0000000..418e397
--- /dev/null
+++ b/c-user/region/introduction.rst
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+
+Introduction
+============
+
+The region manager provides facilities to dynamically allocate memory in
+variable sized units. The directives provided by the region manager are:
+
+- :ref:`rtems_region_create`
+
+- :ref:`rtems_region_ident`
+
+- :ref:`rtems_region_delete`
+
+- :ref:`rtems_region_extend`
+
+- :ref:`rtems_region_get_segment`
+
+- :ref:`rtems_region_return_segment`
+
+- :ref:`rtems_region_get_segment_size`
+
+- :ref:`rtems_region_resize_segment`
+
+- :ref:`rtems_region_get_information`
+
+- :ref:`rtems_region_get_free_information`