diff mbox

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

Message ID 1456359092-30724-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit d9f682c894b503a87e7c24f2de1edf4e48b01f5d
Headers show

Commit Message

Bill Fischofer Feb. 25, 2016, 12:11 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 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Mike Holmes March 1, 2016, 7:55 p.m. UTC | #1
does the diagram need an update too ?

http://docs.opendataplane.org/master/linux-generic/output/users-guide.html#_initialization

It shows calling these apis.

On 24 February 2016 at 19:11, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> 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 | 5 +++--

>  1 file changed, 3 insertions(+), 2 deletions(-)

>

> diff --git a/doc/users-guide/users-guide.adoc

> b/doc/users-guide/users-guide.adoc

> index bbb53a7..68e9de5 100644

> --- a/doc/users-guide/users-guide.adoc

> +++ b/doc/users-guide/users-guide.adoc

> @@ -498,9 +498,10 @@ 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

> --

> 2.5.0

>

> _______________________________________________

> lng-odp mailing list

> lng-odp@lists.linaro.org

> https://lists.linaro.org/mailman/listinfo/lng-odp

>




-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collborative, the rest follows"
Bill Fischofer March 1, 2016, 8 p.m. UTC | #2
I don't think so.  What would you change there?  It's an overview and
doesn't show parameters to any ODP API calls.

On Tue, Mar 1, 2016 at 1:55 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> does the diagram need an update too ?

>

>

> http://docs.opendataplane.org/master/linux-generic/output/users-guide.html#_initialization

>

> It shows calling these apis.

>

> On 24 February 2016 at 19:11, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

>> 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 | 5 +++--

>>  1 file changed, 3 insertions(+), 2 deletions(-)

>>

>> diff --git a/doc/users-guide/users-guide.adoc

>> b/doc/users-guide/users-guide.adoc

>> index bbb53a7..68e9de5 100644

>> --- a/doc/users-guide/users-guide.adoc

>> +++ b/doc/users-guide/users-guide.adoc

>> @@ -498,9 +498,10 @@ 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

>> --

>> 2.5.0

>>

>> _______________________________________________

>> lng-odp mailing list

>> lng-odp@lists.linaro.org

>> https://lists.linaro.org/mailman/listinfo/lng-odp

>>

>

>

>

> --

> Mike Holmes

> Technical Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

> "Work should be fun and collborative, the rest follows"

>

>

>
Mike Holmes March 1, 2016, 8:38 p.m. UTC | #3
On 1 March 2016 at 15:00, Bill Fischofer <bill.fischofer@linaro.org> wrote:

> I don't think so.  What would you change there?  It's an overview and

> doesn't show parameters to any ODP API calls.

>


Ok


>

> On Tue, Mar 1, 2016 at 1:55 PM, Mike Holmes <mike.holmes@linaro.org>

> wrote:

>

>> does the diagram need an update too ?

>>

>>

>> http://docs.opendataplane.org/master/linux-generic/output/users-guide.html#_initialization

>>

>> It shows calling these apis.

>>

>> On 24 February 2016 at 19:11, Bill Fischofer <bill.fischofer@linaro.org>

>> wrote:

>>

>>> 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 | 5 +++--

>>>  1 file changed, 3 insertions(+), 2 deletions(-)

>>>

>>> diff --git a/doc/users-guide/users-guide.adoc

>>> b/doc/users-guide/users-guide.adoc

>>> index bbb53a7..68e9de5 100644

>>> --- a/doc/users-guide/users-guide.adoc

>>> +++ b/doc/users-guide/users-guide.adoc

>>> @@ -498,9 +498,10 @@ 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

>>> --

>>> 2.5.0

>>>

>>> _______________________________________________

>>> lng-odp mailing list

>>> lng-odp@lists.linaro.org

>>> https://lists.linaro.org/mailman/listinfo/lng-odp

>>>

>>

>>

>>

>> --

>> Mike Holmes

>> Technical Manager - Linaro Networking Group

>> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

>> "Work should be fun and collborative, the rest follows"

>>

>>

>>

>



-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collborative, the rest follows"
Bill Fischofer March 26, 2016, 7:49 p.m. UTC | #4
Ping.  Needs review and merge to resolve bug
https://bugs.linaro.org/show_bug.cgi?id=2058

On Tue, Mar 1, 2016 at 2:38 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

>

> On 1 March 2016 at 15:00, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

>> I don't think so.  What would you change there?  It's an overview and

>> doesn't show parameters to any ODP API calls.

>>

>

> Ok

>

>

>>

>> On Tue, Mar 1, 2016 at 1:55 PM, Mike Holmes <mike.holmes@linaro.org>

>> wrote:

>>

>>> does the diagram need an update too ?

>>>

>>>

>>> http://docs.opendataplane.org/master/linux-generic/output/users-guide.html#_initialization

>>>

>>> It shows calling these apis.

>>>

>>> On 24 February 2016 at 19:11, Bill Fischofer <bill.fischofer@linaro.org>

>>> wrote:

>>>

>>>> 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 | 5 +++--

>>>>  1 file changed, 3 insertions(+), 2 deletions(-)

>>>>

>>>> diff --git a/doc/users-guide/users-guide.adoc

>>>> b/doc/users-guide/users-guide.adoc

>>>> index bbb53a7..68e9de5 100644

>>>> --- a/doc/users-guide/users-guide.adoc

>>>> +++ b/doc/users-guide/users-guide.adoc

>>>> @@ -498,9 +498,10 @@ 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

>>>> --

>>>> 2.5.0

>>>>

>>>> _______________________________________________

>>>> lng-odp mailing list

>>>> lng-odp@lists.linaro.org

>>>> https://lists.linaro.org/mailman/listinfo/lng-odp

>>>>

>>>

>>>

>>>

>>> --

>>> Mike Holmes

>>> Technical Manager - Linaro Networking Group

>>> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM

>>> SoCs

>>> "Work should be fun and collborative, the rest follows"

>>>

>>>

>>>

>>

>

>

> --

> Mike Holmes

> Technical Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

> "Work should be fun and collborative, the rest follows"

>

>

>
Maxim Uvarov March 28, 2016, 2:20 p.m. UTC | #5
Looks good,
Merged!

Maxim.

On 03/26/16 22:49, Bill Fischofer wrote:
> Ping.  Needs review and merge to resolve bug 
> https://bugs.linaro.org/show_bug.cgi?id=2058
>
> On Tue, Mar 1, 2016 at 2:38 PM, Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>> wrote:
>
>
>     On 1 March 2016 at 15:00, Bill Fischofer
>     <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>> wrote:
>
>         I don't think so.  What would you change there?  It's an
>         overview and doesn't show parameters to any ODP API calls.
>
>
>     Ok
>
>
>         On Tue, Mar 1, 2016 at 1:55 PM, Mike Holmes
>         <mike.holmes@linaro.org <mailto:mike.holmes@linaro.org>> wrote:
>
>             does the diagram need an update too ?
>
>             http://docs.opendataplane.org/master/linux-generic/output/users-guide.html#_initialization
>
>             It shows calling these apis.
>
>             On 24 February 2016 at 19:11, Bill Fischofer
>             <bill.fischofer@linaro.org
>             <mailto:bill.fischofer@linaro.org>> wrote:
>
>                 This addresses Bug
>                 https://bugs.linaro.org/show_bug.cgi?id=2058
>
>                 Signed-off-by: Bill Fischofer
>                 <bill.fischofer@linaro.org
>                 <mailto:bill.fischofer@linaro.org>>
>                 ---
>                  doc/users-guide/users-guide.adoc | 5 +++--
>                  1 file changed, 3 insertions(+), 2 deletions(-)
>
>                 diff --git a/doc/users-guide/users-guide.adoc
>                 b/doc/users-guide/users-guide.adoc
>                 index bbb53a7..68e9de5 100644
>                 --- a/doc/users-guide/users-guide.adoc
>                 +++ b/doc/users-guide/users-guide.adoc
>                 @@ -498,9 +498,10 @@ 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
>                 --
>                 2.5.0
>
>                 _______________________________________________
>                 lng-odp mailing list
>                 lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>                 https://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
>             -- 
>             Mike Holmes
>             Technical Manager - Linaro Networking Group
>             Linaro.org <http://www.linaro.org/>***│ *Open source
>             software for ARM SoCs
>             "Work should be fun and collborative, the rest follows"
>
>
>
>
>
>     -- 
>     Mike Holmes
>     Technical Manager - Linaro Networking Group
>     Linaro.org <http://www.linaro.org/>***│ *Open source software for
>     ARM SoCs
>     "Work should be fun and collborative, the rest follows"
>
>
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index bbb53a7..68e9de5 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -498,9 +498,10 @@  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