[LTP] [PATCH v2 6/9] include: Document memory test utilities

[Petr Vorel]

Hi Andrea,

> +++ b/include/tst_memutils.h
...
> -/*
> - * Read the value of SwapFree from /proc/meminfo.
> +/**
> + * tst_available_swap() - Reads free swap from /proc/meminfo.
Maybe worth tho note SwapFree:

* tst_available_swap() - Reads free swap from /proc/meminfo using SwapFree.

> + *
> + * Return: Available swap space in KiB.
>   */
>  long long tst_available_swap(void);

...
> @@ -63,10 +59,10 @@ void tst_disable_oom_protection(pid_t pid);
>  /**
>   * tst_mapping_in_range() - Returns true if there is a mapping provided range.
>   *
> - * @low: A lower address inside of the processe address space.
> - * @high: A higher address inside of the processe address space.
> + * @low: A lower address inside of the process address space.
> + * @high: A higher address inside of the process address space.
>   *
> - * return: Returns true if there is a mapping between low and high addresses in
> + * Return: Returns true if there is a mapping between low and high addresses in
>   *         the process address space.

This is causes wrong formatting: "Returns true if there is a mapping between low
and high addresses in" being bold. Please adjust before merge.

Reviewed-by: Petr Vorel <pvorel@suse.cz>

Kind regards,
Petr

diff --git include/tst_memutils.h include/tst_memutils.h
index e3f18c45ef..2be476191f 100644
--- include/tst_memutils.h
+++ include/tst_memutils.h
@@ -63,7 +63,7 @@ void tst_disable_oom_protection(pid_t pid);
  * @high: A higher address inside of the process address space.
  *
  * Return: Returns true if there is a mapping between low and high addresses in
- *         the process address space.
+ * the process address space.
  */
 int tst_mapping_in_range(unsigned long low, unsigned long high);