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

[Huang, Shaoqin]

On 7/27/2022 5:40 PM, Mike Rapoport wrote:
> On Wed, Jul 27, 2022 at 06:16:15PM -0600, shaoqin.huang@xxxxxxxxx wrote:
> > From: Shaoqin Huang <shaoqin.huang@xxxxxxxxx>
> >
> > 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 also add some description about
> > it.
> >
> > Signed-off-by: Shaoqin Huang <shaoqin.huang@xxxxxxxxx>
> > ---
> >   tools/testing/memblock/README | 19 ++++++++++---------
> >   1 file changed, 10 insertions(+), 9 deletions(-)
> >
> > diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> > index 058146b528a5..f39cc0aa6b76 100644
> > --- a/tools/testing/memblock/README
> > +++ b/tools/testing/memblock/README
> > @@ -33,20 +33,21 @@ 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:
>
> The description of VERBOSE build option was a logical continuation of the
> previous sentence.
>
> Instead of doing mechanical changes, please rearrange the text so it'll
> make sense.

I agree. I will try to give a clear and continuation description.

> > +A successful run produces no output. It it also possible to override different
> > +configuration parameters. For example, to simulate enabled NUMA, use:
> >   
> > -$ make VERBOSE=1
> > +$ make NUMA=1
> >   
> > -This will print information about which functions are being tested and the
> > -number of test cases that passed.
> > +For the full list of options, see `make help`.
> >   
> > -To simulate enabled NUMA, use:
> > +It is also possible to pass options at run time. For example:
> >   
> > -$ make NUMA=1
> > +$ ./main -v
> >   
> > -For the full list of options, see `make help`.
> > +This will print information about which functions are being tested and the
> > +number of test cases that passed.
> > +
> > +For the full list of options, see `./main --help`.
> >   
> >   Project structure
> >   =================
> > --
> > 2.30.2