diff mbox

[API-NEXT,2/2] api: queue: clarify odp_queue_context_set() documentation

Message ID 1438016566-13800-2-git-send-email-stuart.haslam@linaro.org
State Accepted
Commit 630bbafd678e14da50a7c49fe948e0b92d1fee4e
Headers show

Commit Message

Stuart Haslam July 27, 2015, 5:02 p.m. UTC
Reword slightly and remove reference to OpenEM specific term EO.

Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org>
---
Noticed this while making the previous change. I see there was some
discussion about it a little while back [1] but no change was never
made.

[1] https://lists.linaro.org/pipermail/lng-odp/2015-April/011182.html

 include/odp/api/queue.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Bill Fischofer July 27, 2015, 9:46 p.m. UTC | #1
On Mon, Jul 27, 2015 at 12:02 PM, Stuart Haslam <stuart.haslam@linaro.org>
wrote:

> Reword slightly and remove reference to OpenEM specific term EO.
>
> Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org>
>

Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>


> ---
> Noticed this while making the previous change. I see there was some
> discussion about it a little while back [1] but no change was never
> made.
>
> [1] https://lists.linaro.org/pipermail/lng-odp/2015-April/011182.html
>
>  include/odp/api/queue.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h
> index 4d85930..ce04eb4 100644
> --- a/include/odp/api/queue.h
> +++ b/include/odp/api/queue.h
> @@ -123,9 +123,9 @@ odp_queue_t odp_queue_lookup(const char *name);
>  /**
>   * Set queue context
>   *
> - * It is the responsibility of the interface user to make sure
> - * queue context allocation is done in an area reachable for
> - * all EOs accessing the context
> + * It is the responsibility of the user to ensure that the queue context
> + * is stored in a location accessible by all threads that attempt to
> + * access it.
>   *
>   * @param queue    Queue handle
>   * @param context  Address to the queue context
> --
> 2.1.1
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
>
diff mbox

Patch

diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h
index 4d85930..ce04eb4 100644
--- a/include/odp/api/queue.h
+++ b/include/odp/api/queue.h
@@ -123,9 +123,9 @@  odp_queue_t odp_queue_lookup(const char *name);
 /**
  * Set queue context
  *
- * It is the responsibility of the interface user to make sure
- * queue context allocation is done in an area reachable for
- * all EOs accessing the context
+ * It is the responsibility of the user to ensure that the queue context
+ * is stored in a location accessible by all threads that attempt to
+ * access it.
  *
  * @param queue    Queue handle
  * @param context  Address to the queue context