[rtems-central commit] spec: Review Partition Manager

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    08435847c7b941f06398384ac8adbb49f4494142
Changeset: http://git.rtems.org/rtems-central/commit/?id=08435847c7b941f06398384ac8adbb49f4494142

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Oct 13 14:17:26 2020 +0200

spec: Review Partition Manager

---

 spec/rtems/part/if/create.yml        | 13 +++++++------
 spec/rtems/part/if/get-buffer.yml    |  4 ++--
 spec/rtems/part/if/return-buffer.yml |  4 ++--
 3 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml
index e6bcd9f..5a335b8 100644
--- a/spec/rtems/part/if/create.yml
+++ b/spec/rtems/part/if/create.yml
@@ -32,13 +32,14 @@ description: |
   The partition can have **local** or **global** scope in a multiprocessing
   network (this attribute does not refer to SMP systems).
 
-  * A **local** is the default and can be emphasized through the use of the
-    ${../../attr/if/local:/name} attribute.  A local partition can be only used
-    by the node which created it.
+  * A **local** scope is the default and can be emphasized through the use of
+    the ${../../attr/if/local:/name} attribute.  A local partition can be only
+    used by the node which created it.
 
-  * A **global** is created if the ${../../attr/if/global:/name} attribute is
-    set.  The memory space used for the partition must reside in shared memory.
-    Setting the global attribute in a single node system has no effect.
+  * A **global** scope is established if the ${../../attr/if/global:/name}
+    attribute is set.  The memory space used for the partition must reside in
+    shared memory.  Setting the global attribute in a single node system has no
+    effect.
 enabled-by: true
 index-entries:
 - create a partition
diff --git a/spec/rtems/part/if/get-buffer.yml b/spec/rtems/part/if/get-buffer.yml
index 6706be9..c6d62d7 100644
--- a/spec/rtems/part/if/get-buffer.yml
+++ b/spec/rtems/part/if/get-buffer.yml
@@ -15,8 +15,8 @@ definition:
   variants: []
 description: |
   This directive allows a buffer to be obtained from the partition specified in
-  the ${.:/params[0]/name} parameter.  The address of the allocated buffer is
-  returned through the ${.:/params[1]/name} parameter.
+  the ``${.:/params[0]/name}`` parameter.  The address of the allocated buffer is
+  returned through the ``${.:/params[1]/name}`` parameter.
 enabled-by: true
 index-entries:
 - get buffer from partition
diff --git a/spec/rtems/part/if/return-buffer.yml b/spec/rtems/part/if/return-buffer.yml
index de1a9fa..2239035 100644
--- a/spec/rtems/part/if/return-buffer.yml
+++ b/spec/rtems/part/if/return-buffer.yml
@@ -14,8 +14,8 @@ definition:
     return: ${../../status/if/code:/name}
   variants: []
 description: |
-  This directive returns the buffer specified by ${.:/params[1]/name} to the
-  partition specified by ${.:/params[0]/name}.
+  This directive returns the buffer specified by ``${.:/params[1]/name}`` to the
+  partition specified by ``${.:/params[0]/name}``.
 enabled-by: true
 index-entries:
 - return buffer to partition