diff mbox series

[API-NEXT,v1,1/2] api: shm: name is optional

Message ID 1512997210-20605-2-git-send-email-odpbot@yandex.ru
State New
Headers show
Series [API-NEXT,v1,1/2] api: shm: name is optional | expand

Commit Message

Github ODP bot Dec. 11, 2017, 1 p.m. UTC 
From: Petri Savolainen <petri.savolainen@linaro.org>


Align shared memory name parameter specification with other
APIs. Name is optional and does not need to be unique, except
when it's used for lookups.

Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>

---
/** Email created from pull request 333 (psavol:next-shm-name)
 ** https://github.com/Linaro/odp/pull/333
 ** Patch: https://github.com/Linaro/odp/pull/333.patch
 ** Base sha: 0980001e33b4190133d478a0aa2e718fd1e3c164
 ** Merge commit sha: 543dc97f844948140c579c8f47f833a61ae7ec78
 **/
 include/odp/api/spec/shared_memory.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/odp/api/spec/shared_memory.h b/include/odp/api/spec/shared_memory.h
index 60a0cdde3..38c82a106 100644
--- a/include/odp/api/spec/shared_memory.h
+++ b/include/odp/api/spec/shared_memory.h
@@ -127,7 +127,14 @@  int odp_shm_capability(odp_shm_capability_t *capa);
 /**
  * Reserve a contiguous block of shared memory
  *
- * @param name   Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars)
+ * Reserve a contiguous block of shared memory that fulfills size, alignment
+ * and shareability (ODP_SHM_* flags) requirements. In general, a name is
+ * optional and does not need to be unique. However, if the block will be
+ * searched with odp_shm_lookup() or odp_shm_import(), a unique name is needed
+ * for correct match.
+ *
+ * @param name   Name of the block or NULL. Maximum string length is
+ *               ODP_SHM_NAME_LEN.
  * @param size   Block size in bytes
  * @param align  Block alignment in bytes
  * @param flags  Shared memory parameter flags (ODP_SHM_*). Default value is 0.