Re: [LTP] [PATCH v2 9/9] include: Fix API comment spelling and style

[Petr Vorel <pvorel@suse.cz>]

Hi Andrea,

>  /**
> - * tse_nodemap_count_pages() - Check which numa node resides each page.
> + * tse_nodemap_count_pages() - Check on which NUMA node each page resides.
>   *
>   * Check on which numa node resides each page of the mapping starting at ptr
>   * and continuing pages long and increases nodemap counters accordingly.
> @@ -114,7 +114,7 @@ enum tse_numa_types {
>   *             requested amount of free+buffers memory it's not included in
>   *             the resulting list of nodes.
>   *
> - * return: On success returns allocated and initialized struct tse_nodemap which contains
> + * Return: On success returns allocated and initialized struct tse_nodemap which contains
>   *         array of numa node ids that contains desired resources.

Although lowercase 'r' on return also works as expected (but it's indeed better
to unify), again: whitespace on the second line breaks formatting (first line is
bold, second line is shifted.

Unfortunately Return: does not work like struct members, which allow shifting
without any formatting (OTOH other formating e.g. lists does not work on them).

The rest hopefully LGTM.
Reviewed-by: Petr Vorel <pvorel@suse.cz>
Thanks for whole patchset.

Kind regards,
Petr

diff --git include/tse_numa.h include/tse_numa.h
index add048eb4c..ac6aab41b8 100644
--- include/tse_numa.h
+++ include/tse_numa.h
@@ -114,8 +114,8 @@ enum tse_numa_types {
  *             requested amount of free+buffers memory it's not included in
  *             the resulting list of nodes.
  *
- * Return: On success returns allocated and initialized struct tse_nodemap which contains
- *         array of numa node ids that contains desired resources.
+ * Return: On success returns allocated and initialized struct tse_nodemap which
+ * contains array of numa node ids that contains desired resources.
  */
 struct tse_nodemap *tse_get_nodemap(int type, size_t min_mem_kb);
 

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp