diff mbox

api: odp_coremask: Improve documentation

Message ID 1420234216-2912-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit 68c7b7e88b1b948868d35497e715cf5077e90e40
Headers show

Commit Message

Mike Holmes Jan. 2, 2015, 9:30 p.m. UTC
The output format was not clear, describe the format of the returned
string.

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

Comments

Bill Fischofer Jan. 7, 2015, 9:57 p.m. UTC | #1
On Fri, Jan 2, 2015 at 3:30 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> The output format was not clear, describe the format of the returned
> string.
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>

Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>


> ---
>  platform/linux-generic/include/api/odp_coremask.h | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/platform/linux-generic/include/api/odp_coremask.h
> b/platform/linux-generic/include/api/odp_coremask.h
> index fe86457..c9331fd 100644
> --- a/platform/linux-generic/include/api/odp_coremask.h
> +++ b/platform/linux-generic/include/api/odp_coremask.h
> @@ -56,6 +56,8 @@ void odp_coremask_from_str(const char *str,
> odp_coremask_t *mask);
>  /**
>   * Write core mask as a string of hexadecimal digits
>   *
> + * The result will be prefixed with 0x and will be in hexadecimal
> + *
>   * @param str    String for output
>   * @param len    Size of string length (incl. ending zero)
>   * @param mask   Core mask
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Jan. 12, 2015, 5:49 p.m. UTC | #2
Merged,
Maxim.

On 01/03/2015 12:30 AM, Mike Holmes wrote:
> The output format was not clear, describe the format of the returned
> string.
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>   platform/linux-generic/include/api/odp_coremask.h | 2 ++
>   1 file changed, 2 insertions(+)
>
> diff --git a/platform/linux-generic/include/api/odp_coremask.h b/platform/linux-generic/include/api/odp_coremask.h
> index fe86457..c9331fd 100644
> --- a/platform/linux-generic/include/api/odp_coremask.h
> +++ b/platform/linux-generic/include/api/odp_coremask.h
> @@ -56,6 +56,8 @@ void odp_coremask_from_str(const char *str, odp_coremask_t *mask);
>   /**
>    * Write core mask as a string of hexadecimal digits
>    *
> + * The result will be prefixed with 0x and will be in hexadecimal
> + *
>    * @param str    String for output
>    * @param len    Size of string length (incl. ending zero)
>    * @param mask   Core mask
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_coremask.h b/platform/linux-generic/include/api/odp_coremask.h
index fe86457..c9331fd 100644
--- a/platform/linux-generic/include/api/odp_coremask.h
+++ b/platform/linux-generic/include/api/odp_coremask.h
@@ -56,6 +56,8 @@  void odp_coremask_from_str(const char *str, odp_coremask_t *mask);
 /**
  * Write core mask as a string of hexadecimal digits
  *
+ * The result will be prefixed with 0x and will be in hexadecimal
+ *
  * @param str    String for output
  * @param len    Size of string length (incl. ending zero)
  * @param mask   Core mask