2022-07-29 01:26:37

by Huang, Shaoqin

[permalink] [raw]
Subject: [PATCH v3] memblock test: Modify the obsolete description in README

From: Shaoqin Huang <[email protected]>

The VERBOSE option in Makefile has been moved, but there still have the
description left in README. For now, we use `-v` options when running
memblock test to print information, so using the new to replace the
obsolete items.

Signed-off-by: Shaoqin Huang <[email protected]>
---
Changelog:
----------
v3:
- Using `build options` replace `options` to make it more clear.
v2:
- Tweak the sentence to make it more clear and continuesly.
- Commit log changes.

tools/testing/memblock/README | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
index 058146b528a5..72162b5f4a76 100644
--- a/tools/testing/memblock/README
+++ b/tools/testing/memblock/README
@@ -33,20 +33,23 @@ To run the tests, build the main target and run it:

$ make && ./main

-A successful run produces no output. It is also possible to override different
-configuration parameters. For example, to include verbose output, specify the
-VERBOSE flag when building the main target:
+A successful run produces no output. It is possible to control the behavior
+by passing options from command line. For example, to include verbose output,
+append the `-v` options when you run the tests:

-$ make VERBOSE=1
+$ ./main -v

This will print information about which functions are being tested and the
number of test cases that passed.

-To simulate enabled NUMA, use:
+For the full list of options from command line, see `./main --help`.
+
+It is also possible to override different configuration parameters to change it
+test functions. For example, To simulate enabled NUMA, use:

$ make NUMA=1

-For the full list of options, see `make help`.
+For the full list of build options, see `make help`.

Project structure
=================
--
2.30.2


2022-07-29 22:09:20

by Rebecca Mckeever

[permalink] [raw]
Subject: Re: [PATCH v3] memblock test: Modify the obsolete description in README

On Fri, Jul 29, 2022 at 10:11:25AM -0600, [email protected] wrote:
> From: Shaoqin Huang <[email protected]>
>
> The VERBOSE option in Makefile has been moved, but there still have the
> description left in README. For now, we use `-v` options when running
> memblock test to print information, so using the new to replace the
> obsolete items.
>
> Signed-off-by: Shaoqin Huang <[email protected]>
> ---
> Changelog:
> ----------
> v3:
> - Using `build options` replace `options` to make it more clear.
> v2:
> - Tweak the sentence to make it more clear and continuesly.
> - Commit log changes.
>
Looks good!

Acked-by: Rebecca Mckeever <[email protected]>

> tools/testing/memblock/README | 15 +++++++++------
> 1 file changed, 9 insertions(+), 6 deletions(-)
>
> diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> index 058146b528a5..72162b5f4a76 100644
> --- a/tools/testing/memblock/README
> +++ b/tools/testing/memblock/README
> @@ -33,20 +33,23 @@ To run the tests, build the main target and run it:
>
> $ make && ./main
>
> -A successful run produces no output. It is also possible to override different
> -configuration parameters. For example, to include verbose output, specify the
> -VERBOSE flag when building the main target:
> +A successful run produces no output. It is possible to control the behavior
> +by passing options from command line. For example, to include verbose output,
> +append the `-v` options when you run the tests:
>
> -$ make VERBOSE=1
> +$ ./main -v
>
> This will print information about which functions are being tested and the
> number of test cases that passed.
>
> -To simulate enabled NUMA, use:
> +For the full list of options from command line, see `./main --help`.
> +
> +It is also possible to override different configuration parameters to change it
> +test functions. For example, To simulate enabled NUMA, use:
>
> $ make NUMA=1
>
> -For the full list of options, see `make help`.
> +For the full list of build options, see `make help`.
>
> Project structure
> =================
> --
> 2.30.2
>
>
Thanks,
Rebecca

2022-07-30 09:10:23

by Mike Rapoport

[permalink] [raw]
Subject: Re: [PATCH v3] memblock test: Modify the obsolete description in README

On Fri, Jul 29, 2022 at 10:11:25AM -0600, [email protected] wrote:
> From: Shaoqin Huang <[email protected]>
>
> The VERBOSE option in Makefile has been moved, but there still have the
> description left in README. For now, we use `-v` options when running
> memblock test to print information, so using the new to replace the
> obsolete items.
>
> Signed-off-by: Shaoqin Huang <[email protected]>
> ---
> Changelog:
> ----------
> v3:
> - Using `build options` replace `options` to make it more clear.
> v2:
> - Tweak the sentence to make it more clear and continuesly.
> - Commit log changes.
>
> tools/testing/memblock/README | 15 +++++++++------
> 1 file changed, 9 insertions(+), 6 deletions(-)

Applied, thanks!

> diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> index 058146b528a5..72162b5f4a76 100644
> --- a/tools/testing/memblock/README
> +++ b/tools/testing/memblock/README
> @@ -33,20 +33,23 @@ To run the tests, build the main target and run it:
>
> $ make && ./main
>
> -A successful run produces no output. It is also possible to override different
> -configuration parameters. For example, to include verbose output, specify the
> -VERBOSE flag when building the main target:
> +A successful run produces no output. It is possible to control the behavior
> +by passing options from command line. For example, to include verbose output,
> +append the `-v` options when you run the tests:
>
> -$ make VERBOSE=1
> +$ ./main -v
>
> This will print information about which functions are being tested and the
> number of test cases that passed.
>
> -To simulate enabled NUMA, use:
> +For the full list of options from command line, see `./main --help`.
> +
> +It is also possible to override different configuration parameters to change it
> +test functions. For example, To simulate enabled NUMA, use:
>
> $ make NUMA=1
>
> -For the full list of options, see `make help`.
> +For the full list of build options, see `make help`.
>
> Project structure
> =================
> --
> 2.30.2
>
>

--
Sincerely yours,
Mike.