[PATCH v2] memblock test: Modify the obsolete description in README

[PATCH v2] memblock test: Modify the obsolete description in README

[shaoqin.huang]

From: Shaoqin Huang <shaoqin.huang@intel.com>

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 <shaoqin.huang@intel.com>
---
Changelog:
----------
v2:
  - Tweak the sentence to make it more clear and continuesly.
  - Commit log changes.

 tools/testing/memblock/README | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
index 058146b528a5..d3875e7065fd 100644
--- a/tools/testing/memblock/README
+++ b/tools/testing/memblock/README
@@ -33,16 +33,19 @@ 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
 
-- 
2.30.2

Re: [PATCH v2] memblock test: Modify the obsolete description in README

[Rebecca Mckeever]

On Wed, Jul 27, 2022 at 07:12:28PM -0600, shaoqin.huang@intel.com wrote:
> From: Shaoqin Huang <shaoqin.huang@intel.com>
> 
> 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.
> 
Thanks for catching this!

> Signed-off-by: Shaoqin Huang <shaoqin.huang@intel.com>
> ---
> Changelog:
> ----------
> v2:
>   - Tweak the sentence to make it more clear and continuesly.
>   - Commit log changes.
> 
>  tools/testing/memblock/README | 13 ++++++++-----
>  1 file changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> index 058146b528a5..d3875e7065fd 100644
> --- a/tools/testing/memblock/README
> +++ b/tools/testing/memblock/README
> @@ -33,16 +33,19 @@ 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`.

--help will display the list of command line options by default, but a
help command line option isn't explicitly implemented. I'm planning to add
the help option, so if you want to remove this sentence, I will add it when
I implement the help option.  
> +
> +It is also possible to override different configuration parameters to change it
> +test functions. For example, To simulate enabled NUMA, use:
>  
>  $ make NUMA=1
>  
Maybe you could add "build" before "options" in the line after this:

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

> -- 
> 2.30.2
> 
> 

Re: [PATCH v2] memblock test: Modify the obsolete description in README

[Huang, Shaoqin]

On 7/28/2022 12:05 PM, Rebecca Mckeever wrote:
> On Wed, Jul 27, 2022 at 07:12:28PM -0600, shaoqin.huang@intel.com wrote:
>> From: Shaoqin Huang <shaoqin.huang@intel.com>
>>
>> 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.
>>
> Thanks for catching this!
> 
>> Signed-off-by: Shaoqin Huang <shaoqin.huang@intel.com>
>> ---
>> Changelog:
>> ----------
>> v2:
>>    - Tweak the sentence to make it more clear and continuesly.
>>    - Commit log changes.
>>
>>   tools/testing/memblock/README | 13 ++++++++-----
>>   1 file changed, 8 insertions(+), 5 deletions(-)
>>
>> diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
>> index 058146b528a5..d3875e7065fd 100644
>> --- a/tools/testing/memblock/README
>> +++ b/tools/testing/memblock/README
>> @@ -33,16 +33,19 @@ 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`.
> 
> --help will display the list of command line options by default, but a
> help command line option isn't explicitly implemented. I'm planning to add
> the help option, so if you want to remove this sentence, I will add it when
> I implement the help option.

Hi, Rebecca.

That's ok. I didn't notice the --help has not been implemented. So I can 
remove the line:
-For the full list of options from command line, see `./main --help`.

But after remove it. There seems a little stranger about how to get the 
full list of options at the time. How do you think about it?

>> +
>> +It is also possible to override different configuration parameters to change it
>> +test functions. For example, To simulate enabled NUMA, use:
>>   
>>   $ make NUMA=1
>>   
> Maybe you could add "build" before "options" in the line after this:
> 
> -For the full list of options, see `make help`.
> +For the full list of build options, see `make help`.
> 

Thanks for you advice to makes it looks better.

>> -- 
>> 2.30.2
>>
>>

Re: [PATCH v2] memblock test: Modify the obsolete description in README

[Mike Rapoport]

On Thu, Jul 28, 2022 at 01:08:25PM +0800, Huang, Shaoqin wrote:
> 
> 
> On 7/28/2022 12:05 PM, Rebecca Mckeever wrote:
> > On Wed, Jul 27, 2022 at 07:12:28PM -0600, shaoqin.huang@intel.com wrote:
> > > From: Shaoqin Huang <shaoqin.huang@intel.com>
> > > 
> > > 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.
> > > 
> > Thanks for catching this!
> > 
> > > Signed-off-by: Shaoqin Huang <shaoqin.huang@intel.com>
> > > ---

...

> > >   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`.
> > 
> > --help will display the list of command line options by default, but a
> > help command line option isn't explicitly implemented. I'm planning to add
> > the help option, so if you want to remove this sentence, I will add it when
> > I implement the help option.
> 
> Hi, Rebecca.
> 
> That's ok. I didn't notice the --help has not been implemented. So I can
> remove the line:
> -For the full list of options from command line, see `./main --help`.
> 
> But after remove it. There seems a little stranger about how to get the full
> list of options at the time. How do you think about it?

I '--help' option is implemented, it just does not list help for itself.
I think it's fine to keep the "For the full list..." line.
 

-- 
Sincerely yours,
Mike.

Re: [PATCH v2] memblock test: Modify the obsolete description in README

[Huang, Shaoqin]

On 7/28/2022 5:01 PM, Mike Rapoport wrote:
> On Thu, Jul 28, 2022 at 01:08:25PM +0800, Huang, Shaoqin wrote:
>>
>>
>> On 7/28/2022 12:05 PM, Rebecca Mckeever wrote:
>>> On Wed, Jul 27, 2022 at 07:12:28PM -0600, shaoqin.huang@intel.com wrote:
>>>> From: Shaoqin Huang <shaoqin.huang@intel.com>
>>>>
>>>> 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.
>>>>
>>> Thanks for catching this!
>>>
>>>> Signed-off-by: Shaoqin Huang <shaoqin.huang@intel.com>
>>>> ---
> 
> ...
> 
>>>>    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`.
>>>
>>> --help will display the list of command line options by default, but a
>>> help command line option isn't explicitly implemented. I'm planning to add
>>> the help option, so if you want to remove this sentence, I will add it when
>>> I implement the help option.
>>
>> Hi, Rebecca.
>>
>> That's ok. I didn't notice the --help has not been implemented. So I can
>> remove the line:
>> -For the full list of options from command line, see `./main --help`.
>>
>> But after remove it. There seems a little stranger about how to get the full
>> list of options at the time. How do you think about it?
> 
> I '--help' option is implemented, it just does not list help for itself.
> I think it's fine to keep the "For the full list..." line.
>   
> 

Ok, if no other problem. I will resend this patch with a minimal tweak:
-For the full list of options, see `make help`.
+For the full list of build options, see `make help`.