On 4 August 2016 at 08:40, Maxim Uvarov <[email protected]> wrote: > I'm not sure that: > > platform/linux-generic/include/odp/api/platform_specific.dox > directory is good for documentation files.
Do we want to create a directory for a single file when the need for other files is not clear? > > I do not see also corresponding changes in Makefile like EXTRA_DIST I guess you are right here: I probably missed something... Hope Mike comes with good hints as I am not sure where this is handled... Christophe > > Mike, can you please also review. Doxygen looks like your field :) > > Thank you, > Maxim. > > > > On 08/03/16 22:17, Christophe Milard wrote: >> >> ping >> >> >> On 29 July 2016 at 19:33, Bill Fischofer <[email protected]> >> wrote: >>> >>> >>> On Thu, Jul 28, 2016 at 6:59 AM, Christophe Milard >>> <[email protected]> wrote: >>>> >>>> Defining an odp thread for the linux generic implementation of ODP. >>>> >>>> Signed-off-by: Christophe Milard <[email protected]> >>> >>> >>> Reviewed-and-tested-by: Bill Fischofer <[email protected]> >>> >>>> --- >>>> .../include/odp/api/platform_specific.dox | 46 >>>> ++++++++++++++++++++++ >>>> 1 file changed, 46 insertions(+) >>>> create mode 100644 >>>> platform/linux-generic/include/odp/api/platform_specific.dox >>>> >>>> diff --git >>>> a/platform/linux-generic/include/odp/api/platform_specific.dox >>>> b/platform/linux-generic/include/odp/api/platform_specific.dox >>>> new file mode 100644 >>>> index 0000000..e116ec6 >>>> --- /dev/null >>>> +++ b/platform/linux-generic/include/odp/api/platform_specific.dox >>>> @@ -0,0 +1,46 @@ >>>> +/* Copyright (c) 2016, Linaro Limited >>>> + * All rights reserved >>>> + * >>>> + * SPDX-License-Identifier: BSD-3-Clause >>>> + */ >>>> + >>>> +/** >>>> +* @file platform_specific.dox >>>> +* extra linux-generic documentation >>>> +*/ >>>> + >>>> +/** @addtogroup odp_thread >>>> + * @par ODP thread >>>> + * In this ODP implementation an odp thread is either: >>>> + * - a linux process descendant (or same as) the odp instantiation >>>> process. >>>> + * - a pthread 'member' of a linux process descendant (or same as) the >>>> odp >>>> + * instantiation process. >>>> + */ >>>> + >>>> +/** >>>> + * @fn odp_init_local(odp_instance_t instance, odp_thread_type_t >>>> thr_type) >>>> + * @note In this ODP implementation odpthreads have to be >>>> + * processes descendant of (or same as) the ODP >>>> + * instantiation process, or pthreads 'member' of >>>> such >>>> + * processes. >>>> + * @note As ODP instantiation processes cannot be >>>> descendants >>>> + * of each others, the instance parameter provided >>>> + * to odp_init_local() is actually fully defined by >>>> these >>>> + * requirements: It has to be the value returned by >>>> the >>>> + * unique call to odp_init_global() made by one >>>> single >>>> + * acsendant of the current process. >>>> + */ >>>> + >>>> +/** >>>> + * @fn odp_init_global(odp_instance_t *instance, >>>> + * const odp_init_t *params, >>>> + * const odp_platform_init_t *platform_params) >>>> + * @note This ODP implementation supports mupliple instances of >>>> ODP >>>> + * (i.e. multiple call to odp_init_global()) with the >>>> following >>>> + * restrictions: >>>> + * @note -Different ODP instances cannot share the same >>>> instantiation >>>> + * process. In other words, a single process may >>>> + * only call odp_init_global() once. >>>> + * @note -Different ODP instantiation processes cannot be >>>> descendant of >>>> + * each other. >>>> + */ >>>> -- >>>> 2.7.4 >>>> >
