diff mbox

api: odp_thread: documentation

Message ID 1420042841-5581-1-git-send-email-mike.holmes@linaro.org
State Rejected
Headers show

Commit Message

Mike Holmes Dec. 31, 2014, 4:20 p.m. UTC 
Improve the definition of thread and core ids

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 platform/linux-generic/include/api/odp_thread.h | 2 ++
 1 file changed, 2 insertions(+)
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_thread.h b/platform/linux-generic/include/api/odp_thread.h
index 2b7177d..debcefd 100644
--- a/platform/linux-generic/include/api/odp_thread.h
+++ b/platform/linux-generic/include/api/odp_thread.h
@@ -24,6 +24,7 @@  extern "C" {
 
 /**
  * Get thread id
+ * Threads are numbered from 0 to n
  *
  * @return Thread id of the current thread
  */
@@ -32,6 +33,7 @@  int odp_thread_id(void);
 
 /**
  * Get core id
+ * Cores are numbered to match their native host scheme
  *
  * @return Core id where the thread is running currently
  */