diff mbox

api: odp_coremask: Fix doxygen list

Message ID 1420225615-28960-1-git-send-email-mike.holmes@linaro.org
State Accepted
Headers show

Commit Message

Mike Holmes Jan. 2, 2015, 7:06 p.m. UTC
Doxygen needs " - " to form a list

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Mike Holmes Jan. 10, 2015, 1:08 p.m. UTC | #1
ping

On 2 January 2015 at 14:06, Mike Holmes <mike.holmes@linaro.org> wrote:

> Doxygen needs " - " to form a list
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>  platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_coremask.h
> b/platform/linux-generic/include/api/odp_coremask.h
> index d4172fa..fe86457 100644
> --- a/platform/linux-generic/include/api/odp_coremask.h
> +++ b/platform/linux-generic/include/api/odp_coremask.h
> @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int len, const
> odp_coremask_t *mask);
>   * of the first word (u64[0] = 0x1).
>   *
>   * Examples
> - * core 0:  u64[0] = 0x1
> - * core 1:  u64[0] = 0x2
> - * ...
> - * core 63: u64[0] = 0x8000 0000 0000 0000
> - * core 64: u64[0] = 0x0, u64[1] = 0x1
> - * core 65: u64[0] = 0x0, u64[1] = 0x2
> + * - core 0:  u64[0] = 0x1
> + * - core 1:  u64[0] = 0x2
> + * - ...
> + * - core 63: u64[0] = 0x8000 0000 0000 0000
> + * - core 64: u64[0] = 0x0, u64[1] = 0x1
> + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>   *
>   * @param u64    An array of u64 bit words
>   * @param num    Number of u64 words in the array
> --
> 2.1.0
>
>
Ciprian Barbu Jan. 12, 2015, 11:04 a.m. UTC | #2
Looks good!

Reviewed-by: Ciprian Barbu <ciprian.barbu@linaro.org>

On Sat, Jan 10, 2015 at 3:08 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
> ping
>
> On 2 January 2015 at 14:06, Mike Holmes <mike.holmes@linaro.org> wrote:
>>
>> Doxygen needs " - " to form a list
>>
>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>> ---
>>  platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
>>  1 file changed, 6 insertions(+), 6 deletions(-)
>>
>> diff --git a/platform/linux-generic/include/api/odp_coremask.h
>> b/platform/linux-generic/include/api/odp_coremask.h
>> index d4172fa..fe86457 100644
>> --- a/platform/linux-generic/include/api/odp_coremask.h
>> +++ b/platform/linux-generic/include/api/odp_coremask.h
>> @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int len, const
>> odp_coremask_t *mask);
>>   * of the first word (u64[0] = 0x1).
>>   *
>>   * Examples
>> - * core 0:  u64[0] = 0x1
>> - * core 1:  u64[0] = 0x2
>> - * ...
>> - * core 63: u64[0] = 0x8000 0000 0000 0000
>> - * core 64: u64[0] = 0x0, u64[1] = 0x1
>> - * core 65: u64[0] = 0x0, u64[1] = 0x2
>> + * - core 0:  u64[0] = 0x1
>> + * - core 1:  u64[0] = 0x2
>> + * - ...
>> + * - core 63: u64[0] = 0x8000 0000 0000 0000
>> + * - core 64: u64[0] = 0x0, u64[1] = 0x1
>> + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>>   *
>>   * @param u64    An array of u64 bit words
>>   * @param num    Number of u64 words in the array
>> --
>> 2.1.0
>>
>
>
>
> --
> Mike Holmes
> Linaro  Sr Technical Manager
> LNG - ODP
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Ciprian Barbu Jan. 12, 2015, 11:05 a.m. UTC | #3
On Mon, Jan 12, 2015 at 1:04 PM, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:
> Looks good!
>
> Reviewed-by: Ciprian Barbu <ciprian.barbu@linaro.org>

I also tested it

>
> On Sat, Jan 10, 2015 at 3:08 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
>> ping
>>
>> On 2 January 2015 at 14:06, Mike Holmes <mike.holmes@linaro.org> wrote:
>>>
>>> Doxygen needs " - " to form a list
>>>
>>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>>> ---
>>>  platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
>>>  1 file changed, 6 insertions(+), 6 deletions(-)
>>>
>>> diff --git a/platform/linux-generic/include/api/odp_coremask.h
>>> b/platform/linux-generic/include/api/odp_coremask.h
>>> index d4172fa..fe86457 100644
>>> --- a/platform/linux-generic/include/api/odp_coremask.h
>>> +++ b/platform/linux-generic/include/api/odp_coremask.h
>>> @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int len, const
>>> odp_coremask_t *mask);
>>>   * of the first word (u64[0] = 0x1).
>>>   *
>>>   * Examples
>>> - * core 0:  u64[0] = 0x1
>>> - * core 1:  u64[0] = 0x2
>>> - * ...
>>> - * core 63: u64[0] = 0x8000 0000 0000 0000
>>> - * core 64: u64[0] = 0x0, u64[1] = 0x1
>>> - * core 65: u64[0] = 0x0, u64[1] = 0x2
>>> + * - core 0:  u64[0] = 0x1
>>> + * - core 1:  u64[0] = 0x2
>>> + * - ...
>>> + * - core 63: u64[0] = 0x8000 0000 0000 0000
>>> + * - core 64: u64[0] = 0x0, u64[1] = 0x1
>>> + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>>>   *
>>>   * @param u64    An array of u64 bit words
>>>   * @param num    Number of u64 words in the array
>>> --
>>> 2.1.0
>>>
>>
>>
>>
>> --
>> Mike Holmes
>> Linaro  Sr Technical Manager
>> LNG - ODP
>>
>> _______________________________________________
>> lng-odp mailing list
>> lng-odp@lists.linaro.org
>> http://lists.linaro.org/mailman/listinfo/lng-odp
>>
Maxim Uvarov Jan. 12, 2015, 4:17 p.m. UTC | #4
That is already applied as part of:

commit 7fd717d8ffdff7f09e4824a28bedaa9829f80cff
Author: Anders Roxell <anders.roxell@linaro.org>
Date:   Thu Aug 21 02:03:02 2014 +0200

     Move includes back into linux-generic


Maxim.

On 01/02/2015 10:06 PM, Mike Holmes wrote:
> Doxygen needs " - " to form a list
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>   platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
>   1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_coremask.h b/platform/linux-generic/include/api/odp_coremask.h
> index d4172fa..fe86457 100644
> --- a/platform/linux-generic/include/api/odp_coremask.h
> +++ b/platform/linux-generic/include/api/odp_coremask.h
> @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int len, const odp_coremask_t *mask);
>    * of the first word (u64[0] = 0x1).
>    *
>    * Examples
> - * core 0:  u64[0] = 0x1
> - * core 1:  u64[0] = 0x2
> - * ...
> - * core 63: u64[0] = 0x8000 0000 0000 0000
> - * core 64: u64[0] = 0x0, u64[1] = 0x1
> - * core 65: u64[0] = 0x0, u64[1] = 0x2
> + * - core 0:  u64[0] = 0x1
> + * - core 1:  u64[0] = 0x2
> + * - ...
> + * - core 63: u64[0] = 0x8000 0000 0000 0000
> + * - core 64: u64[0] = 0x0, u64[1] = 0x1
> + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>    *
>    * @param u64    An array of u64 bit words
>    * @param num    Number of u64 words in the array
Mike Holmes Jan. 12, 2015, 4:47 p.m. UTC | #5
On 12 January 2015 at 11:17, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> That is already applied as part of:
>

I am not sure what was applied but the problem is still there without this
fix

http://docs.opendataplane.org/odp/html/group__odp
__scheduler.html#gaf205db4597618fcdf1d278da0b320c04

It should not all be on one line
"Examples core 0: u64[0] = 0x1 core 1: u64[0] = 0x2 ... core 63: u64[0] =
0x8000 0000 0000 0000 core 64: u64[0] = 0x0, u64[1] = 0x1 core 65: u64[0] =
0x0, u64[1] = 0x2"


>
> commit 7fd717d8ffdff7f09e4824a28bedaa9829f80cff
> Author: Anders Roxell <anders.roxell@linaro.org>
> Date:   Thu Aug 21 02:03:02 2014 +0200
>
>     Move includes back into linux-generic
>
>
> Maxim.
>
>
> On 01/02/2015 10:06 PM, Mike Holmes wrote:
>
>> Doxygen needs " - " to form a list
>>
>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>> ---
>>   platform/linux-generic/include/api/odp_coremask.h | 12 ++++++------
>>   1 file changed, 6 insertions(+), 6 deletions(-)
>>
>> diff --git a/platform/linux-generic/include/api/odp_coremask.h
>> b/platform/linux-generic/include/api/odp_coremask.h
>> index d4172fa..fe86457 100644
>> --- a/platform/linux-generic/include/api/odp_coremask.h
>> +++ b/platform/linux-generic/include/api/odp_coremask.h
>> @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int len, const
>> odp_coremask_t *mask);
>>    * of the first word (u64[0] = 0x1).
>>    *
>>    * Examples
>> - * core 0:  u64[0] = 0x1
>> - * core 1:  u64[0] = 0x2
>> - * ...
>> - * core 63: u64[0] = 0x8000 0000 0000 0000
>> - * core 64: u64[0] = 0x0, u64[1] = 0x1
>> - * core 65: u64[0] = 0x0, u64[1] = 0x2
>> + * - core 0:  u64[0] = 0x1
>> + * - core 1:  u64[0] = 0x2
>> + * - ...
>> + * - core 63: u64[0] = 0x8000 0000 0000 0000
>> + * - core 64: u64[0] = 0x0, u64[1] = 0x1
>> + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>>    *
>>    * @param u64    An array of u64 bit words
>>    * @param num    Number of u64 words in the array
>>
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Jan. 12, 2015, 4:51 p.m. UTC | #6
Hm, applied when I saved one more time email to file.

Maxim.

On 01/12/2015 07:47 PM, Mike Holmes wrote:
>
>
> On 12 January 2015 at 11:17, Maxim Uvarov <maxim.uvarov@linaro.org 
> <mailto:maxim.uvarov@linaro.org>> wrote:
>
>     That is already applied as part of:
>
>
> I am not sure what was applied but the problem is still there without 
> this fix
>
> http://docs.opendataplane.org/odp/html/group__odp__scheduler.html#gaf205db4597618fcdf1d278da0b320c04
>
> It should not all be on one line
> "Examples core 0: u64[0] = 0x1 core 1: u64[0] = 0x2 ... core 63: 
> u64[0] = 0x8000 0000 0000 0000 core 64: u64[0] = 0x0, u64[1] = 0x1 
> core 65: u64[0] = 0x0, u64[1] = 0x2"
>
>
>     commit 7fd717d8ffdff7f09e4824a28bedaa9829f80cff
>     Author: Anders Roxell <anders.roxell@linaro.org
>     <mailto:anders.roxell@linaro.org>>
>     Date:   Thu Aug 21 02:03:02 2014 +0200
>
>         Move includes back into linux-generic
>
>
>     Maxim.
>
>
>     On 01/02/2015 10:06 PM, Mike Holmes wrote:
>
>         Doxygen needs " - " to form a list
>
>         Signed-off-by: Mike Holmes <mike.holmes@linaro.org
>         <mailto:mike.holmes@linaro.org>>
>         ---
>           platform/linux-generic/include/api/odp_coremask.h | 12
>         ++++++------
>           1 file changed, 6 insertions(+), 6 deletions(-)
>
>         diff --git a/platform/linux-generic/include/api/odp_coremask.h
>         b/platform/linux-generic/include/api/odp_coremask.h
>         index d4172fa..fe86457 100644
>         --- a/platform/linux-generic/include/api/odp_coremask.h
>         +++ b/platform/linux-generic/include/api/odp_coremask.h
>         @@ -72,12 +72,12 @@ void odp_coremask_to_str(char *str, int
>         len, const odp_coremask_t *mask);
>            * of the first word (u64[0] = 0x1).
>            *
>            * Examples
>         - * core 0:  u64[0] = 0x1
>         - * core 1:  u64[0] = 0x2
>         - * ...
>         - * core 63: u64[0] = 0x8000 0000 0000 0000
>         - * core 64: u64[0] = 0x0, u64[1] = 0x1
>         - * core 65: u64[0] = 0x0, u64[1] = 0x2
>         + * - core 0:  u64[0] = 0x1
>         + * - core 1:  u64[0] = 0x2
>         + * - ...
>         + * - core 63: u64[0] = 0x8000 0000 0000 0000
>         + * - core 64: u64[0] = 0x0, u64[1] = 0x1
>         + * - core 65: u64[0] = 0x0, u64[1] = 0x2
>            *
>            * @param u64    An array of u64 bit words
>            * @param num    Number of u64 words in the array
>
>
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> -- 
> *Mike Holmes*
> Linaro  Sr Technical Manager
> LNG - ODP
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_coremask.h b/platform/linux-generic/include/api/odp_coremask.h
index d4172fa..fe86457 100644
--- a/platform/linux-generic/include/api/odp_coremask.h
+++ b/platform/linux-generic/include/api/odp_coremask.h
@@ -72,12 +72,12 @@  void odp_coremask_to_str(char *str, int len, const odp_coremask_t *mask);
  * of the first word (u64[0] = 0x1).
  *
  * Examples
- * core 0:  u64[0] = 0x1
- * core 1:  u64[0] = 0x2
- * ...
- * core 63: u64[0] = 0x8000 0000 0000 0000
- * core 64: u64[0] = 0x0, u64[1] = 0x1
- * core 65: u64[0] = 0x0, u64[1] = 0x2
+ * - core 0:  u64[0] = 0x1
+ * - core 1:  u64[0] = 0x2
+ * - ...
+ * - core 63: u64[0] = 0x8000 0000 0000 0000
+ * - core 64: u64[0] = 0x0, u64[1] = 0x1
+ * - core 65: u64[0] = 0x0, u64[1] = 0x2
  *
  * @param u64    An array of u64 bit words
  * @param num    Number of u64 words in the array