diff mbox

doc: userguide: add thread type description to odp_init_local() discussion

Message ID 1456358994-30018-1-git-send-email-bill.fischofer@linaro.org
State Superseded
Headers show

Commit Message

Bill Fischofer Feb. 25, 2016, 12:09 a.m. UTC 
This addresses Bug https://bugs.linaro.org/show_bug.cgi?id=2058

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 doc/users-guide/users-guide.adoc | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
diff mbox

Patch

diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index bbb53a7..7a5e49f 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -498,9 +498,12 @@  suitable for the ODP API.
 Calling odp_init_global() establishes the ODP API framework and MUST be
 called before any other ODP API may be called. Note that it is only called
 once per application. Following global initialization, each thread in turn
-calls 'odp_init_local()' is called. This establishes the local ODP thread
+calls 'odp_init_local()'. This establishes the local ODP thread
 context for that thread and MUST be called before other ODP APIs may be
-called by that thread.
+called by that thread. The sole argument to this call is the _thread type_,
+which is either +ODP_THREAD_WORKER+ or +ODP_THREAD_CONTROL+.
+
+
 
 === Shutdown
 Shutdown is the logical reverse of the initialization procedure, with