diff mbox

[API-NEXT,3/3] doc: shm: defining behaviour when blocks have same name

Message ID 1478598570-2846-4-git-send-email-christophe.milard@linaro.org
State Accepted
Commit 63ef9b3714c9410dd1b5a55e3bd50de49f23dfcb
Headers show

Commit Message

Christophe Milard Nov. 8, 2016, 9:49 a.m. UTC 
Defining the reserve and lookup behaviour when multiple blocks are reserved
using the same name.

Signed-off-by: Christophe Milard <christophe.milard@linaro.org>

---
 doc/users-guide/users-guide.adoc | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

-- 
2.7.4
diff mbox

Patch

diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index a9dc64f..3434a60 100755
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -594,7 +594,9 @@  resource.
 Blocks of shared memory can be created using the `odp_shm_reserve()` API
 call. The call expects a shared memory block name, a block size, an alignment
 requirement, and optional flags as parameters. It returns a `odp_shm_t`
-handle. The size and alignment requirement are given in bytes.
+handle. The size and alignment requirement are given in bytes. The provided
+name does not have to be unique, i.e. a given name can be used multiple times,
+when reserving different blocks.
 
 .creating a block of shared memory
 [source,c]
@@ -670,7 +672,9 @@  block is to use the `odp_shm_lookup()` API function call.
 This nevertheless requires the calling ODP thread to provide the name of the
 shared memory block:
 `odp_shm_lookup()` will return `ODP_SHM_INVALID` if no shared memory block
-with the provided name is known by ODP.
+with the provided name is known by ODP. When multiple blocks were reserved
+using the same name, the lookup function will return the handle of any
+of these blocks.
 
 .retrieving a block handle and address from another ODP task
 [source,c]