[PATCH 0/3] memblock tests: update style of comments

[PATCH 0/3] memblock tests: update style of comments

[Rebecca Mckeever]

These patches update the style of comments for memblock_add_*() and
memblock_reserve_*() functions to match the style of comments in
tests/alloc_*.c and remove extra spaces in those comments to conform
to Linux kernel coding style.

Rebecca Mckeever (3):
  memblock tests: update style of comments for memblock_add_*()
    functions
  memblock tests: update style of comments for memblock_reserve_*()
    functions
  memblock tests: remove extra column of spaces in block comment

 tools/testing/memblock/tests/basic_api.c | 153 ++++++++++++++++-------
 1 file changed, 109 insertions(+), 44 deletions(-)

-- 
2.32.0

[PATCH 1/3] memblock tests: update style of comments for memblock_add_*() functions

[Rebecca Mckeever]

Update comments in memblock_add_*() functions to match the style used
in tests/alloc_*.c by rewording to make the expected outcome more apparent
and, if more than one memblock is involved, adding a visual of the
memory blocks.

Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
---
 tools/testing/memblock/tests/basic_api.c | 75 +++++++++++++++++-------
 1 file changed, 54 insertions(+), 21 deletions(-)

diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
index fbc1ce160303..cdf112d25343 100644
--- a/tools/testing/memblock/tests/basic_api.c
+++ b/tools/testing/memblock/tests/basic_api.c
@@ -26,8 +26,8 @@ static int memblock_initialization_check(void)
 /*
  * A simple test that adds a memory block of a specified base address
  * and size to the collection of available memory regions (memblock.memory).
- * It checks if a new entry was created and if region counter and total memory
- * were correctly updated.
+ * Expect to create a new entry. The region counter and total memory get
+ * updated.
  */
 static int memblock_add_simple_check(void)
 {
@@ -55,8 +55,8 @@ static int memblock_add_simple_check(void)
 /*
  * A simple test that adds a memory block of a specified base address, size
  * NUMA node and memory flags to the collection of available memory regions.
- * It checks if the new entry, region counter and total memory size have
- * expected values.
+ * Expect to create a new entry. The region counter and total memory get
+ * updated.
  */
 static int memblock_add_node_simple_check(void)
 {
@@ -87,9 +87,15 @@ static int memblock_add_node_simple_check(void)
 
 /*
  * A test that tries to add two memory blocks that don't overlap with one
- * another. It checks if two correctly initialized entries were added to the
- * collection of available memory regions (memblock.memory) and if this
- * change was reflected in memblock.memory's total size and region counter.
+ * another:
+ *
+ *  |        +--------+        +--------+  |
+ *  |        |   r1   |        |   r2   |  |
+ *  +--------+--------+--------+--------+--+
+ *
+ * Expect to add two correctly initialized entries to the collection of
+ * available memory regions (memblock.memory). The total size and
+ * region counter fields get updated.
  */
 static int memblock_add_disjoint_check(void)
 {
@@ -125,10 +131,20 @@ static int memblock_add_disjoint_check(void)
 
 /*
  * A test that tries to add two memory blocks, where the second one overlaps
- * with the beginning of the first entry (that is r1.base < r2.base + r2.size).
- * After this, it checks if two entries are merged into one region that starts
- * at r2.base and has size of two regions minus their intersection. It also
- * verifies the reported total size of the available memory and region counter.
+ * with the beginning of the first entry (that is r1.base < r2.base + r2.size):
+ *
+ *  |    +----+----+------------+          |
+ *  |    |   r|2   |   r1       |          |
+ *  +----+----+----+------------+----------+
+ *       ^    ^
+ *       |    |
+ *       |    r1.base
+ *       |
+ *       r2.base
+ *
+ * Expect to merge the two entries into one region that starts at r2.base
+ * and has size of two regions minus their intersection. The total size of
+ * the available memory is updated, and the region counter stays the same.
  */
 static int memblock_add_overlap_top_check(void)
 {
@@ -163,11 +179,20 @@ static int memblock_add_overlap_top_check(void)
 
 /*
  * A test that tries to add two memory blocks, where the second one overlaps
- * with the end of the first entry (that is r2.base < r1.base + r1.size).
- * After this, it checks if two entries are merged into one region that starts
- * at r1.base and has size of two regions minus their intersection. It verifies
- * that memblock can still see only one entry and has a correct total size of
- * the available memory.
+ * with the end of the first entry (that is r2.base < r1.base + r1.size):
+ *
+ *  |  +--+------+----------+              |
+ *  |  |  | r1   | r2       |              |
+ *  +--+--+------+----------+--------------+
+ *     ^  ^
+ *     |  |
+ *     |  r2.base
+ *     |
+ *     r1.base
+ *
+ * Expect to merge the two entries into one region that starts at r1.base
+ * and has size of two regions minus their intersection. The total size of
+ * the available memory is updated, and the region counter stays the same.
  */
 static int memblock_add_overlap_bottom_check(void)
 {
@@ -203,9 +228,17 @@ static int memblock_add_overlap_bottom_check(void)
 /*
  * A test that tries to add two memory blocks, where the second one is
  * within the range of the first entry (that is r1.base < r2.base &&
- * r2.base + r2.size < r1.base + r1.size). It checks if two entries are merged
- * into one region that stays the same. The counter and total size of available
- * memory are expected to not be updated.
+ * r2.base + r2.size < r1.base + r1.size).
+ *
+ *  |   +-------+--+-----------------------+
+ *  |   |       |r2|      r1               |
+ *  +---+-------+--+-----------------------+
+ *      ^
+ *      |
+ *      r1.base
+ *
+ * Expect to merge two entries into one region that stays the same.
+ * The counter and total size of available memory are not updated.
  */
 static int memblock_add_within_check(void)
 {
@@ -236,8 +269,8 @@ static int memblock_add_within_check(void)
 }
 
 /*
- * A simple test that tries to add the same memory block twice. The counter
- * and total size of available memory are expected to not be updated.
+ * A simple test that tries to add the same memory block twice. Expect
+ * the counter and total size of available memory to not be updated.
  */
 static int memblock_add_twice_check(void)
 {
-- 
2.32.0

[PATCH 2/3] memblock tests: update style of comments for memblock_reserve_*() functions

[Rebecca Mckeever]

Update comments in memblock_reserve_*() functions to match the style used
in tests/alloc_*.c by rewording to make the expected outcome more apparent
and, if more than one memblock is involved, adding a visual of the
memory blocks.

Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
---
 tools/testing/memblock/tests/basic_api.c | 70 +++++++++++++++++-------
 1 file changed, 51 insertions(+), 19 deletions(-)

diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
index cdf112d25343..834d8705ff8a 100644
--- a/tools/testing/memblock/tests/basic_api.c
+++ b/tools/testing/memblock/tests/basic_api.c
@@ -306,8 +306,8 @@ static int memblock_add_checks(void)
  /*
   * A simple test that marks a memory block of a specified base address
   * and size as reserved and to the collection of reserved memory regions
-  * (memblock.reserved). It checks if a new entry was created and if region
-  * counter and total memory size were correctly updated.
+  * (memblock.reserved). Expect to create a new entry. The region counter
+  * and total memory size are updated.
   */
 static int memblock_reserve_simple_check(void)
 {
@@ -330,10 +330,15 @@ static int memblock_reserve_simple_check(void)
 }
 
 /*
- * A test that tries to mark two memory blocks that don't overlap as reserved
- * and checks if two entries were correctly added to the collection of reserved
- * memory regions (memblock.reserved) and if this change was reflected in
- * memblock.reserved's total size and region counter.
+ * A test that tries to mark two memory blocks that don't overlap as reserved:
+ *
+ *  |        +--+      +----------------+  |
+ *  |        |r1|      |       r2       |  |
+ *  +--------+--+------+----------------+--+
+ *
+ * Expect to add two entries to the collection of reserved memory regions
+ * (memblock.reserved). The total size and region counter for
+ * memblock.reserved are updated.
  */
 static int memblock_reserve_disjoint_check(void)
 {
@@ -370,11 +375,20 @@ static int memblock_reserve_disjoint_check(void)
 /*
  * A test that tries to mark two memory blocks as reserved, where the
  * second one overlaps with the beginning of the first (that is
- * r1.base < r2.base + r2.size).
- * It checks if two entries are merged into one region that starts at r2.base
- * and has size of two regions minus their intersection. The test also verifies
- * that memblock can still see only one entry and has a correct total size of
- * the reserved memory.
+ * r1.base < r2.base + r2.size):
+ *
+ *  |  +--------------+--+--------------+  |
+ *  |  |       r2     |  |     r1       |  |
+ *  +--+--------------+--+--------------+--+
+ *     ^              ^
+ *     |              |
+ *     |              r1.base
+ *     |
+ *     r2.base
+ *
+ * Expect to merge two entries into one region that starts at r2.base and
+ * has size of two regions minus their intersection. The total size of the
+ * reserved memory is updated, and the region counter is not updated.
  */
 static int memblock_reserve_overlap_top_check(void)
 {
@@ -411,10 +425,19 @@ static int memblock_reserve_overlap_top_check(void)
  * A test that tries to mark two memory blocks as reserved, where the
  * second one overlaps with the end of the first entry (that is
  * r2.base < r1.base + r1.size).
- * It checks if two entries are merged into one region that starts at r1.base
- * and has size of two regions minus their intersection. It verifies that
- * memblock can still see only one entry and has a correct total size of the
- * reserved memory.
+ *
+ *  |  +--------------+--+--------------+  |
+ *  |  |       r1     |  |     r2       |  |
+ *  +--+--------------+--+--------------+--+
+ *     ^              ^
+ *     |              |
+ *     |              r2.base
+ *     |
+ *     r1.base
+ *
+ * Expect to merge two entries into one region that starts at r1.base and
+ * has size of two regions minus their intersection. The total size of the
+ * reserved memory is updated, and the region counter is not updated.
  */
 static int memblock_reserve_overlap_bottom_check(void)
 {
@@ -451,9 +474,18 @@ static int memblock_reserve_overlap_bottom_check(void)
  * A test that tries to mark two memory blocks as reserved, where the second
  * one is within the range of the first entry (that is
  * (r1.base < r2.base) && (r2.base + r2.size < r1.base + r1.size)).
- * It checks if two entries are merged into one region that stays the
- * same. The counter and total size of available memory are expected to not be
- * updated.
+ *
+ *  | +-----+--+---------------------------|
+ *  | |     |r2|          r1               |
+ *  +-+-----+--+---------------------------+
+ *    ^     ^
+ *    |     |
+ *    |     r2.base
+ *    |
+ *    r1.base
+ *
+ * Expect to merge two entries into one region that stays the same. The
+ * counter and total size of available memory are not updated.
  */
 static int memblock_reserve_within_check(void)
 {
@@ -485,7 +517,7 @@ static int memblock_reserve_within_check(void)
 
 /*
  * A simple test that tries to reserve the same memory block twice.
- * The region counter and total size of reserved memory are expected to not
+ * Expect the region counter and total size of reserved memory to not
  * be updated.
  */
 static int memblock_reserve_twice_check(void)
-- 
2.32.0

[PATCH 3/3] memblock tests: remove extra column of spaces in block comment

[Rebecca Mckeever]

Remove extra space at the beginning of each line in block comment
for consistency and to conform to Linux kernel coding style.

Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
---
 tools/testing/memblock/tests/basic_api.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
index 834d8705ff8a..05448a25f1f9 100644
--- a/tools/testing/memblock/tests/basic_api.c
+++ b/tools/testing/memblock/tests/basic_api.c
@@ -303,12 +303,12 @@ static int memblock_add_checks(void)
 	return 0;
 }
 
- /*
-  * A simple test that marks a memory block of a specified base address
-  * and size as reserved and to the collection of reserved memory regions
-  * (memblock.reserved). Expect to create a new entry. The region counter
-  * and total memory size are updated.
-  */
+/*
+ * A simple test that marks a memory block of a specified base address
+ * and size as reserved and to the collection of reserved memory regions
+ * (memblock.reserved). Expect to create a new entry. The region counter
+ * and total memory size are updated.
+ */
 static int memblock_reserve_simple_check(void)
 {
 	struct memblock_region *rgn;
-- 
2.32.0

Re: [PATCH 3/3] memblock tests: remove extra column of spaces in block comment

[David Hildenbrand]

On 20.04.22 13:19, Rebecca Mckeever wrote:
> Remove extra space at the beginning of each line in block comment
> for consistency and to conform to Linux kernel coding style.
> 
> Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> ---
>  tools/testing/memblock/tests/basic_api.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
> index 834d8705ff8a..05448a25f1f9 100644
> --- a/tools/testing/memblock/tests/basic_api.c
> +++ b/tools/testing/memblock/tests/basic_api.c
> @@ -303,12 +303,12 @@ static int memblock_add_checks(void)
>  	return 0;
>  }
>  
> - /*
> -  * A simple test that marks a memory block of a specified base address
> -  * and size as reserved and to the collection of reserved memory regions
> -  * (memblock.reserved). Expect to create a new entry. The region counter
> -  * and total memory size are updated.
> -  */
> +/*
> + * A simple test that marks a memory block of a specified base address
> + * and size as reserved and to the collection of reserved memory regions
> + * (memblock.reserved). Expect to create a new entry. The region counter
> + * and total memory size are updated.
> + */
>  static int memblock_reserve_simple_check(void)
>  {
>  	struct memblock_region *rgn;

I'd pull this patch to the front, so you don't end up modifying a wrong
style in patch #2. You could also just squash this patch into patch #2
and mention it in the patch description.

-- 
Thanks,

David / dhildenb

Re: [PATCH 1/3] memblock tests: update style of comments for memblock_add_*() functions

[David Hildenbrand]

On 20.04.22 13:19, Rebecca Mckeever wrote:
> Update comments in memblock_add_*() functions to match the style used
> in tests/alloc_*.c by rewording to make the expected outcome more apparent
> and, if more than one memblock is involved, adding a visual of the
> memory blocks.
> 
> Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> ---
>  tools/testing/memblock/tests/basic_api.c | 75 +++++++++++++++++-------
>  1 file changed, 54 insertions(+), 21 deletions(-)
> 
> diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
> index fbc1ce160303..cdf112d25343 100644
> --- a/tools/testing/memblock/tests/basic_api.c
> +++ b/tools/testing/memblock/tests/basic_api.c
> @@ -26,8 +26,8 @@ static int memblock_initialization_check(void)
>  /*
>   * A simple test that adds a memory block of a specified base address
>   * and size to the collection of available memory regions (memblock.memory).
> - * It checks if a new entry was created and if region counter and total memory
> - * were correctly updated.
> + * Expect to create a new entry. The region counter and total memory get
> + * updated.
>   */
>  static int memblock_add_simple_check(void)
>  {
> @@ -55,8 +55,8 @@ static int memblock_add_simple_check(void)
>  /*
>   * A simple test that adds a memory block of a specified base address, size
>   * NUMA node and memory flags to the collection of available memory regions.
> - * It checks if the new entry, region counter and total memory size have
> - * expected values.
> + * Expect to create a new entry. The region counter and total memory get
> + * updated.
>   */
>  static int memblock_add_node_simple_check(void)
>  {
> @@ -87,9 +87,15 @@ static int memblock_add_node_simple_check(void)
>  
>  /*
>   * A test that tries to add two memory blocks that don't overlap with one
> - * another. It checks if two correctly initialized entries were added to the
> - * collection of available memory regions (memblock.memory) and if this
> - * change was reflected in memblock.memory's total size and region counter.
> + * another:
> + *
> + *  |        +--------+        +--------+  |
> + *  |        |   r1   |        |   r2   |  |
> + *  +--------+--------+--------+--------+--+
> + *
> + * Expect to add two correctly initialized entries to the collection of
> + * available memory regions (memblock.memory). The total size and
> + * region counter fields get updated.
>   */
>  static int memblock_add_disjoint_check(void)
>  {
> @@ -125,10 +131,20 @@ static int memblock_add_disjoint_check(void)
>  
>  /*
>   * A test that tries to add two memory blocks, where the second one overlaps
> - * with the beginning of the first entry (that is r1.base < r2.base + r2.size).
> - * After this, it checks if two entries are merged into one region that starts
> - * at r2.base and has size of two regions minus their intersection. It also
> - * verifies the reported total size of the available memory and region counter.
> + * with the beginning of the first entry (that is r1.base < r2.base + r2.size):
> + *
> + *  |    +----+----+------------+          |
> + *  |    |   r|2   |   r1       |          |
> + *  +----+----+----+------------+----------+
> + *       ^    ^
> + *       |    |
> + *       |    r1.base
> + *       |
> + *       r2.base
> + *
> + * Expect to merge the two entries into one region that starts at r2.base
> + * and has size of two regions minus their intersection. The total size of
> + * the available memory is updated, and the region counter stays the same.
>   */
>  static int memblock_add_overlap_top_check(void)
>  {
> @@ -163,11 +179,20 @@ static int memblock_add_overlap_top_check(void)
>  
>  /*
>   * A test that tries to add two memory blocks, where the second one overlaps
> - * with the end of the first entry (that is r2.base < r1.base + r1.size).
> - * After this, it checks if two entries are merged into one region that starts
> - * at r1.base and has size of two regions minus their intersection. It verifies
> - * that memblock can still see only one entry and has a correct total size of
> - * the available memory.
> + * with the end of the first entry (that is r2.base < r1.base + r1.size):
> + *
> + *  |  +--+------+----------+              |
> + *  |  |  | r1   | r2       |              |
> + *  +--+--+------+----------+--------------+
> + *     ^  ^
> + *     |  |
> + *     |  r2.base
> + *     |
> + *     r1.base
> + *
> + * Expect to merge the two entries into one region that starts at r1.base
> + * and has size of two regions minus their intersection. The total size of
> + * the available memory is updated, and the region counter stays the same.
>   */
>  static int memblock_add_overlap_bottom_check(void)
>  {
> @@ -203,9 +228,17 @@ static int memblock_add_overlap_bottom_check(void)
>  /*
>   * A test that tries to add two memory blocks, where the second one is
>   * within the range of the first entry (that is r1.base < r2.base &&
> - * r2.base + r2.size < r1.base + r1.size). It checks if two entries are merged
> - * into one region that stays the same. The counter and total size of available
> - * memory are expected to not be updated.
> + * r2.base + r2.size < r1.base + r1.size).
> + *
> + *  |   +-------+--+-----------------------+
> + *  |   |       |r2|      r1               |
> + *  +---+-------+--+-----------------------+
> + *      ^
> + *      |
> + *      r1.base
> + *
> + * Expect to merge two entries into one region that stays the same.
> + * The counter and total size of available memory are not updated.
>   */
>  static int memblock_add_within_check(void)
>  {
> @@ -236,8 +269,8 @@ static int memblock_add_within_check(void)
>  }
>  
>  /*
> - * A simple test that tries to add the same memory block twice. The counter
> - * and total size of available memory are expected to not be updated.
> + * A simple test that tries to add the same memory block twice. Expect
> + * the counter and total size of available memory to not be updated.
>   */
>  static int memblock_add_twice_check(void)
>  {

Reviewed-by: David Hildenbrand <david@redhat.com>

-- 
Thanks,

David / dhildenb

Re: [PATCH 2/3] memblock tests: update style of comments for memblock_reserve_*() functions

[David Hildenbrand]

On 20.04.22 13:19, Rebecca Mckeever wrote:
> Update comments in memblock_reserve_*() functions to match the style used
> in tests/alloc_*.c by rewording to make the expected outcome more apparent
> and, if more than one memblock is involved, adding a visual of the
> memory blocks.
> 
> Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> ---
>  tools/testing/memblock/tests/basic_api.c | 70 +++++++++++++++++-------
>  1 file changed, 51 insertions(+), 19 deletions(-)
> 
> diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
> index cdf112d25343..834d8705ff8a 100644
> --- a/tools/testing/memblock/tests/basic_api.c
> +++ b/tools/testing/memblock/tests/basic_api.c
> @@ -306,8 +306,8 @@ static int memblock_add_checks(void)
>   /*
>    * A simple test that marks a memory block of a specified base address
>    * and size as reserved and to the collection of reserved memory regions
> -  * (memblock.reserved). It checks if a new entry was created and if region
> -  * counter and total memory size were correctly updated.
> +  * (memblock.reserved). Expect to create a new entry. The region counter
> +  * and total memory size are updated.
>    */

As mentioned in reply to patch #3, we try avoiding introducing "more
wrong style" and cleanup afterwards. Cleanup first or along the way.

>  static int memblock_reserve_simple_check(void)
>  {
> @@ -330,10 +330,15 @@ static int memblock_reserve_simple_check(void)
>  }
>  
>  /*
> - * A test that tries to mark two memory blocks that don't overlap as reserved
> - * and checks if two entries were correctly added to the collection of reserved
> - * memory regions (memblock.reserved) and if this change was reflected in
> - * memblock.reserved's total size and region counter.
> + * A test that tries to mark two memory blocks that don't overlap as reserved:
> + *
> + *  |        +--+      +----------------+  |
> + *  |        |r1|      |       r2       |  |
> + *  +--------+--+------+----------------+--+
> + *
> + * Expect to add two entries to the collection of reserved memory regions
> + * (memblock.reserved). The total size and region counter for
> + * memblock.reserved are updated.
>   */
>  static int memblock_reserve_disjoint_check(void)
>  {
> @@ -370,11 +375,20 @@ static int memblock_reserve_disjoint_check(void)
>  /*
>   * A test that tries to mark two memory blocks as reserved, where the
>   * second one overlaps with the beginning of the first (that is
> - * r1.base < r2.base + r2.size).
> - * It checks if two entries are merged into one region that starts at r2.base
> - * and has size of two regions minus their intersection. The test also verifies
> - * that memblock can still see only one entry and has a correct total size of
> - * the reserved memory.
> + * r1.base < r2.base + r2.size):
> + *
> + *  |  +--------------+--+--------------+  |
> + *  |  |       r2     |  |     r1       |  |
> + *  +--+--------------+--+--------------+--+
> + *     ^              ^
> + *     |              |
> + *     |              r1.base
> + *     |
> + *     r2.base
> + *
> + * Expect to merge two entries into one region that starts at r2.base and
> + * has size of two regions minus their intersection. The total size of the
> + * reserved memory is updated, and the region counter is not updated.
>   */
>  static int memblock_reserve_overlap_top_check(void)
>  {
> @@ -411,10 +425,19 @@ static int memblock_reserve_overlap_top_check(void)
>   * A test that tries to mark two memory blocks as reserved, where the
>   * second one overlaps with the end of the first entry (that is
>   * r2.base < r1.base + r1.size).
> - * It checks if two entries are merged into one region that starts at r1.base
> - * and has size of two regions minus their intersection. It verifies that
> - * memblock can still see only one entry and has a correct total size of the
> - * reserved memory.
> + *
> + *  |  +--------------+--+--------------+  |
> + *  |  |       r1     |  |     r2       |  |
> + *  +--+--------------+--+--------------+--+
> + *     ^              ^
> + *     |              |
> + *     |              r2.base
> + *     |
> + *     r1.base
> + *
> + * Expect to merge two entries into one region that starts at r1.base and
> + * has size of two regions minus their intersection. The total size of the
> + * reserved memory is updated, and the region counter is not updated.
>   */
>  static int memblock_reserve_overlap_bottom_check(void)
>  {
> @@ -451,9 +474,18 @@ static int memblock_reserve_overlap_bottom_check(void)
>   * A test that tries to mark two memory blocks as reserved, where the second
>   * one is within the range of the first entry (that is
>   * (r1.base < r2.base) && (r2.base + r2.size < r1.base + r1.size)).
> - * It checks if two entries are merged into one region that stays the
> - * same. The counter and total size of available memory are expected to not be
> - * updated.
> + *
> + *  | +-----+--+---------------------------|
> + *  | |     |r2|          r1               |
> + *  +-+-----+--+---------------------------+
> + *    ^     ^
> + *    |     |
> + *    |     r2.base
> + *    |
> + *    r1.base
> + *
> + * Expect to merge two entries into one region that stays the same. The
> + * counter and total size of available memory are not updated.
>   */
>  static int memblock_reserve_within_check(void)
>  {
> @@ -485,7 +517,7 @@ static int memblock_reserve_within_check(void)
>  
>  /*
>   * A simple test that tries to reserve the same memory block twice.
> - * The region counter and total size of reserved memory are expected to not
> + * Expect the region counter and total size of reserved memory to not
>   * be updated.
>   */
>  static int memblock_reserve_twice_check(void)


Apart from that

Reviewed-by: David Hildenbrand <david@redhat.com>

-- 
Thanks,

David / dhildenb

Re: [PATCH 1/3] memblock tests: update style of comments for memblock_add_*() functions

[Mike Rapoport]

On Thu, Apr 21, 2022 at 09:12:02AM +0200, David Hildenbrand wrote:
> On 20.04.22 13:19, Rebecca Mckeever wrote:
> > Update comments in memblock_add_*() functions to match the style used
> > in tests/alloc_*.c by rewording to make the expected outcome more apparent
> > and, if more than one memblock is involved, adding a visual of the
> > memory blocks.
> > 
> > Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> > ---
> >  tools/testing/memblock/tests/basic_api.c | 75 +++++++++++++++++-------
> >  1 file changed, 54 insertions(+), 21 deletions(-)
> > 
> > diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
> > index fbc1ce160303..cdf112d25343 100644
> > --- a/tools/testing/memblock/tests/basic_api.c
> > +++ b/tools/testing/memblock/tests/basic_api.c
> > @@ -26,8 +26,8 @@ static int memblock_initialization_check(void)
> >  /*
> >   * A simple test that adds a memory block of a specified base address
> >   * and size to the collection of available memory regions (memblock.memory).
> > - * It checks if a new entry was created and if region counter and total memory
> > - * were correctly updated.
> > + * Expect to create a new entry. The region counter and total memory get
> > + * updated.
> >   */
> >  static int memblock_add_simple_check(void)
> >  {
> > @@ -55,8 +55,8 @@ static int memblock_add_simple_check(void)
> >  /*
> >   * A simple test that adds a memory block of a specified base address, size

Can you please add coma after size  ...                                        ^

> >   * NUMA node and memory flags to the collection of available memory regions.
> > - * It checks if the new entry, region counter and total memory size have
> > - * expected values.
> > + * Expect to create a new entry. The region counter and total memory get
> > + * updated.
> >   */
> >  static int memblock_add_node_simple_check(void)
> >  {

...

> > @@ -125,10 +131,20 @@ static int memblock_add_disjoint_check(void)
> >  
> >  /*
> >   * A test that tries to add two memory blocks, where the second one overlaps
> > - * with the beginning of the first entry (that is r1.base < r2.base + r2.size).
> > - * After this, it checks if two entries are merged into one region that starts
> > - * at r2.base and has size of two regions minus their intersection. It also
> > - * verifies the reported total size of the available memory and region counter.
> > + * with the beginning of the first entry (that is r1.base < r2.base + r2.size):
> > + *
> > + *  |    +----+----+------------+          |
> > + *  |    |   r|2   |   r1       |          |
> > + *  +----+----+----+------------+----------+

I'd move | separator outside the block name, e.g

	*  |    +----+----+------------+          |
	*  |    |   | r2  |   r1       |          |
	*  +----+----+----+------------+----------+

but no strong feelings about this :)

> > + *       ^    ^
> > + *       |    |
> > + *       |    r1.base
> > + *       |
> > + *       r2.base
> > + *
> > + * Expect to merge the two entries into one region that starts at r2.base
> > + * and has size of two regions minus their intersection. The total size of
> > + * the available memory is updated, and the region counter stays the same.
> >   */
> >  static int memblock_add_overlap_top_check(void)

...
 
> Reviewed-by: David Hildenbrand <david@redhat.com>
> 
> -- 
> Thanks,
> 
> David / dhildenb
> 
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH 3/3] memblock tests: remove extra column of spaces in block comment

[Mike Rapoport]

On Thu, Apr 21, 2022 at 09:09:58AM +0200, David Hildenbrand wrote:
> On 20.04.22 13:19, Rebecca Mckeever wrote:
> > Remove extra space at the beginning of each line in block comment
> > for consistency and to conform to Linux kernel coding style.
> > 
> > Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> > ---
> >  tools/testing/memblock/tests/basic_api.c | 12 ++++++------
> >  1 file changed, 6 insertions(+), 6 deletions(-)
> > 
> > diff --git a/tools/testing/memblock/tests/basic_api.c b/tools/testing/memblock/tests/basic_api.c
> > index 834d8705ff8a..05448a25f1f9 100644
> > --- a/tools/testing/memblock/tests/basic_api.c
> > +++ b/tools/testing/memblock/tests/basic_api.c
> > @@ -303,12 +303,12 @@ static int memblock_add_checks(void)
> >  	return 0;
> >  }
> >  
> > - /*
> > -  * A simple test that marks a memory block of a specified base address
> > -  * and size as reserved and to the collection of reserved memory regions
> > -  * (memblock.reserved). Expect to create a new entry. The region counter
> > -  * and total memory size are updated.
> > -  */
> > +/*
> > + * A simple test that marks a memory block of a specified base address
> > + * and size as reserved and to the collection of reserved memory regions
> > + * (memblock.reserved). Expect to create a new entry. The region counter
> > + * and total memory size are updated.
> > + */
> >  static int memblock_reserve_simple_check(void)
> >  {
> >  	struct memblock_region *rgn;
> 
> I'd pull this patch to the front, so you don't end up modifying a wrong
> style in patch #2. You could also just squash this patch into patch #2
> and mention it in the patch description.

Let's squash this into patch 2.

> -- 
> Thanks,
> 
> David / dhildenb
> 

-- 
Sincerely yours,
Mike.