diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-14 09:18:23 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-15 07:47:38 +0200 |
commit | c70715baea93828a0e7b27f4ae583dc254e1a6a9 (patch) | |
tree | 5199462cc2405dcb6d1b070b2b9ff249ea6f43a8 /c-user/partition/directives.rst | |
parent | user: add bsps/aarch64/a72.rst (diff) | |
download | rtems-docs-c70715baea93828a0e7b27f4ae583dc254e1a6a9.tar.bz2 |
c-user: Use a common phrase for pointer parameters
Mention the type of the pointer in the parameter description. Use the
more general term "object" instead of "variable".
Update #3993.
Diffstat (limited to 'c-user/partition/directives.rst')
-rw-r--r-- | c-user/partition/directives.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/c-user/partition/directives.rst b/c-user/partition/directives.rst index 98c0eb1..534cfb4 100644 --- a/c-user/partition/directives.rst +++ b/c-user/partition/directives.rst @@ -76,9 +76,9 @@ Creates a partition. This parameter is the attribute set of the partition. ``id`` - This parameter is the pointer to an object identifier variable. When the + This parameter is the pointer to an :c:type:`rtems_id` object. When the directive call is successful, the identifier of the created partition will - be stored in this variable. + be stored in this object. .. rubric:: DESCRIPTION: @@ -241,9 +241,9 @@ Identifies a partition by the object name. This parameter is the node or node set to search for a matching object. ``id`` - This parameter is the pointer to an object identifier variable. When the + This parameter is the pointer to an :c:type:`rtems_id` object. When the directive call is successful, the object identifier of an object with the - specified name will be stored in this variable. + specified name will be stored in this object. .. rubric:: DESCRIPTION: @@ -415,9 +415,9 @@ Tries to get a buffer from the partition. This parameter is the partition identifier. ``buffer`` - This parameter is the pointer to a buffer pointer variable. When the + This parameter is the pointer to a ``void`` pointer object. When the directive call is successful, the pointer to the allocated buffer will be - stored in this variable. + stored in this object. .. rubric:: DESCRIPTION: |