diff mbox series

[v3,1/4] memblock tests: add user-provided arguments to Makefile

Message ID b7e8e89dbbd7acdf41d62f1528f02d1dc2283e4b.1655889641.git.remckee0@gmail.com (mailing list archive)
State New
Headers show
Series memblock tests: add VERBOSE and MEMBLOCK_DEBUG Makefile options | expand

Commit Message

Rebecca Mckeever June 22, 2022, 9:29 a.m. UTC 
Add VERBOSE and MEMBLOCK_DEBUG user-provided arguments. VERBOSE will
enable verbose output from Memblock simulator. MEMBLOCK_DEBUG will enable
memblock_dbg() messages.

Update the help message to include VERBOSE and MEMBLOCK_DEBUG. Update
the README to include VERBOSE. The README does not include all available
options and refers to the help message for the remaining options.
Therefore, omit MEMBLOCK_DEBUG from README.

Reviewed-by: David Hildenbrand <david@redhat.com>
Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
---
 tools/testing/memblock/Makefile                 |  4 ++++
 tools/testing/memblock/README                   | 10 +++++++++-
 tools/testing/memblock/scripts/Makefile.include | 10 ++++++++++
 3 files changed, 23 insertions(+), 1 deletion(-)

Comments

Mike Rapoport June 23, 2022, 3:47 a.m. UTC | #1 
Hi Rebecca,

On Wed, Jun 22, 2022 at 04:29:06AM -0500, Rebecca Mckeever wrote:
>
> Subject: memblock tests: add user-provided arguments to Makefile

Please be more specific here, e.g. 

memblock tests: Makefile: add arguments to control verbosity

> Add VERBOSE and MEMBLOCK_DEBUG user-provided arguments. VERBOSE will
> enable verbose output from Memblock simulator. MEMBLOCK_DEBUG will enable
> memblock_dbg() messages.
> 
> Update the help message to include VERBOSE and MEMBLOCK_DEBUG. Update
> the README to include VERBOSE. The README does not include all available
> options and refers to the help message for the remaining options.
> Therefore, omit MEMBLOCK_DEBUG from README.
> 
> Reviewed-by: David Hildenbrand <david@redhat.com>
> Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> ---
>  tools/testing/memblock/Makefile                 |  4 ++++
>  tools/testing/memblock/README                   | 10 +++++++++-
>  tools/testing/memblock/scripts/Makefile.include | 10 ++++++++++
>  3 files changed, 23 insertions(+), 1 deletion(-)
> 
> diff --git a/tools/testing/memblock/Makefile b/tools/testing/memblock/Makefile
> index a698e24b35e7..9fde49ad73bd 100644
> --- a/tools/testing/memblock/Makefile
> +++ b/tools/testing/memblock/Makefile
> @@ -45,6 +45,10 @@ help:
>  	@echo  '  clean		  - Remove generated files and symlinks in the directory'
>  	@echo  ''
>  	@echo  'Configuration:'
> +	@echo  '  make VERBOSE=1            - enable verbose output, which includes the'
> +	@echo  '                              names of functions being tested and the'
> +	@echo  '                              number of test cases passing'
> +	@echo  '  make MEMBLOCK_DEBUG=1     - enable memblock_dbg() messages'
>  	@echo  '  make NUMA=1               - simulate enabled NUMA'
>  	@echo  '  make MOVABLE_NODE=1       - override `movable_node_is_enabled`'
>  	@echo  '                              definition to simulate movable NUMA nodes'
> diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> index ca6afcff013a..058146b528a5 100644
> --- a/tools/testing/memblock/README
> +++ b/tools/testing/memblock/README
> @@ -34,7 +34,15 @@ 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 simulate enabled NUMA, use:
> +configuration parameters. For example, to include verbose output, specify the
> +VERBOSE flag when building the main target:
> +
> +$ make VERBOSE=1
> +
> +This will print information about which functions are being tested and the
> +number of test cases that passed.
> +
> +To simulate enabled NUMA, use:
>  
>  $ make NUMA=1
>  
> diff --git a/tools/testing/memblock/scripts/Makefile.include b/tools/testing/memblock/scripts/Makefile.include
> index 641569ccb7b0..4401f79bed4c 100644
> --- a/tools/testing/memblock/scripts/Makefile.include
> +++ b/tools/testing/memblock/scripts/Makefile.include
> @@ -17,3 +17,13 @@ ifeq ($(32BIT_PHYS_ADDR_T), 1)
>  	CFLAGS += -m32 -U CONFIG_PHYS_ADDR_T_64BIT
>  	LDFLAGS += -m32
>  endif
> +
> +# Enable verbose testing output
> +ifeq ($(VERBOSE), 1)
> +	CFLAGS += -D VERBOSE
> +endif
> +
> +# Enable memblock_dbg() messages
> +ifeq ($(MEMBLOCK_DEBUG), 1)
> +	CFLAGS += -D MEMBLOCK_DEBUG
> +endif
> -- 
> 2.34.1
>
Rebecca Mckeever June 23, 2022, 4:45 a.m. UTC | #2 
Hi Mike,

On Wed, Jun 22, 2022 at 10:47:55PM -0500, Mike Rapoport wrote:
> Hi Rebecca,
> 
> On Wed, Jun 22, 2022 at 04:29:06AM -0500, Rebecca Mckeever wrote:
> >
> > Subject: memblock tests: add user-provided arguments to Makefile
> 
> Please be more specific here, e.g. 
> 
> memblock tests: Makefile: add arguments to control verbosity
>
Should I also mention debug messages, or does verbosity refer to both
arguments?

> > Add VERBOSE and MEMBLOCK_DEBUG user-provided arguments. VERBOSE will
> > enable verbose output from Memblock simulator. MEMBLOCK_DEBUG will enable
> > memblock_dbg() messages.
> > 
> > Update the help message to include VERBOSE and MEMBLOCK_DEBUG. Update
> > the README to include VERBOSE. The README does not include all available
> > options and refers to the help message for the remaining options.
> > Therefore, omit MEMBLOCK_DEBUG from README.
> > 
> > Reviewed-by: David Hildenbrand <david@redhat.com>
> > Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> > ---
> >  tools/testing/memblock/Makefile                 |  4 ++++
> >  tools/testing/memblock/README                   | 10 +++++++++-
> >  tools/testing/memblock/scripts/Makefile.include | 10 ++++++++++
> >  3 files changed, 23 insertions(+), 1 deletion(-)
> > 
> > diff --git a/tools/testing/memblock/Makefile b/tools/testing/memblock/Makefile
> > index a698e24b35e7..9fde49ad73bd 100644
> > --- a/tools/testing/memblock/Makefile
> > +++ b/tools/testing/memblock/Makefile
> > @@ -45,6 +45,10 @@ help:
> >  	@echo  '  clean		  - Remove generated files and symlinks in the directory'
> >  	@echo  ''
> >  	@echo  'Configuration:'
> > +	@echo  '  make VERBOSE=1            - enable verbose output, which includes the'
> > +	@echo  '                              names of functions being tested and the'
> > +	@echo  '                              number of test cases passing'
> > +	@echo  '  make MEMBLOCK_DEBUG=1     - enable memblock_dbg() messages'
> >  	@echo  '  make NUMA=1               - simulate enabled NUMA'
> >  	@echo  '  make MOVABLE_NODE=1       - override `movable_node_is_enabled`'
> >  	@echo  '                              definition to simulate movable NUMA nodes'
> > diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> > index ca6afcff013a..058146b528a5 100644
> > --- a/tools/testing/memblock/README
> > +++ b/tools/testing/memblock/README
> > @@ -34,7 +34,15 @@ 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 simulate enabled NUMA, use:
> > +configuration parameters. For example, to include verbose output, specify the
> > +VERBOSE flag when building the main target:
> > +
> > +$ make VERBOSE=1
> > +
> > +This will print information about which functions are being tested and the
> > +number of test cases that passed.
> > +
> > +To simulate enabled NUMA, use:
> >  
> >  $ make NUMA=1
> >  
> > diff --git a/tools/testing/memblock/scripts/Makefile.include b/tools/testing/memblock/scripts/Makefile.include
> > index 641569ccb7b0..4401f79bed4c 100644
> > --- a/tools/testing/memblock/scripts/Makefile.include
> > +++ b/tools/testing/memblock/scripts/Makefile.include
> > @@ -17,3 +17,13 @@ ifeq ($(32BIT_PHYS_ADDR_T), 1)
> >  	CFLAGS += -m32 -U CONFIG_PHYS_ADDR_T_64BIT
> >  	LDFLAGS += -m32
> >  endif
> > +
> > +# Enable verbose testing output
> > +ifeq ($(VERBOSE), 1)
> > +	CFLAGS += -D VERBOSE
> > +endif
> > +
> > +# Enable memblock_dbg() messages
> > +ifeq ($(MEMBLOCK_DEBUG), 1)
> > +	CFLAGS += -D MEMBLOCK_DEBUG
> > +endif
> > -- 
> > 2.34.1
> > 
> 
> -- 
> Sincerely yours,
> Mike.

Thanks,
Rebecca
Mike Rapoport June 23, 2022, 4:52 a.m. UTC | #3 
On Wed, Jun 22, 2022 at 11:45:36PM -0500, Rebecca Mckeever wrote:
> Hi Mike,
> 
> On Wed, Jun 22, 2022 at 10:47:55PM -0500, Mike Rapoport wrote:
> > Hi Rebecca,
> > 
> > On Wed, Jun 22, 2022 at 04:29:06AM -0500, Rebecca Mckeever wrote:
> > >
> > > Subject: memblock tests: add user-provided arguments to Makefile
> > 
> > Please be more specific here, e.g. 
> > 
> > memblock tests: Makefile: add arguments to control verbosity
> >
>
> Should I also mention debug messages, or does verbosity refer to both
> arguments?

It does as enabling memblock_dbg() is also about overall verbosity.
But if you manage to squeeze both in 75 characters I won't mind :)
 
> > > Add VERBOSE and MEMBLOCK_DEBUG user-provided arguments. VERBOSE will
> > > enable verbose output from Memblock simulator. MEMBLOCK_DEBUG will enable
> > > memblock_dbg() messages.
> > > 
> > > Update the help message to include VERBOSE and MEMBLOCK_DEBUG. Update
> > > the README to include VERBOSE. The README does not include all available
> > > options and refers to the help message for the remaining options.
> > > Therefore, omit MEMBLOCK_DEBUG from README.
> > > 
> > > Reviewed-by: David Hildenbrand <david@redhat.com>
> > > Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> > > ---
> > >  tools/testing/memblock/Makefile                 |  4 ++++
> > >  tools/testing/memblock/README                   | 10 +++++++++-
> > >  tools/testing/memblock/scripts/Makefile.include | 10 ++++++++++
> > >  3 files changed, 23 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/tools/testing/memblock/Makefile b/tools/testing/memblock/Makefile
> > > index a698e24b35e7..9fde49ad73bd 100644
> > > --- a/tools/testing/memblock/Makefile
> > > +++ b/tools/testing/memblock/Makefile
> > > @@ -45,6 +45,10 @@ help:
> > >  	@echo  '  clean		  - Remove generated files and symlinks in the directory'
> > >  	@echo  ''
> > >  	@echo  'Configuration:'
> > > +	@echo  '  make VERBOSE=1            - enable verbose output, which includes the'
> > > +	@echo  '                              names of functions being tested and the'
> > > +	@echo  '                              number of test cases passing'
> > > +	@echo  '  make MEMBLOCK_DEBUG=1     - enable memblock_dbg() messages'
> > >  	@echo  '  make NUMA=1               - simulate enabled NUMA'
> > >  	@echo  '  make MOVABLE_NODE=1       - override `movable_node_is_enabled`'
> > >  	@echo  '                              definition to simulate movable NUMA nodes'
> > > diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
> > > index ca6afcff013a..058146b528a5 100644
> > > --- a/tools/testing/memblock/README
> > > +++ b/tools/testing/memblock/README
> > > @@ -34,7 +34,15 @@ 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 simulate enabled NUMA, use:
> > > +configuration parameters. For example, to include verbose output, specify the
> > > +VERBOSE flag when building the main target:
> > > +
> > > +$ make VERBOSE=1
> > > +
> > > +This will print information about which functions are being tested and the
> > > +number of test cases that passed.
> > > +
> > > +To simulate enabled NUMA, use:
> > >  
> > >  $ make NUMA=1
> > >  
> > > diff --git a/tools/testing/memblock/scripts/Makefile.include b/tools/testing/memblock/scripts/Makefile.include
> > > index 641569ccb7b0..4401f79bed4c 100644
> > > --- a/tools/testing/memblock/scripts/Makefile.include
> > > +++ b/tools/testing/memblock/scripts/Makefile.include
> > > @@ -17,3 +17,13 @@ ifeq ($(32BIT_PHYS_ADDR_T), 1)
> > >  	CFLAGS += -m32 -U CONFIG_PHYS_ADDR_T_64BIT
> > >  	LDFLAGS += -m32
> > >  endif
> > > +
> > > +# Enable verbose testing output
> > > +ifeq ($(VERBOSE), 1)
> > > +	CFLAGS += -D VERBOSE
> > > +endif
> > > +
> > > +# Enable memblock_dbg() messages
> > > +ifeq ($(MEMBLOCK_DEBUG), 1)
> > > +	CFLAGS += -D MEMBLOCK_DEBUG
> > > +endif
> > > -- 
> > > 2.34.1
> > > 
> > 
> > -- 
> > Sincerely yours,
> > Mike.
> 
> Thanks,
> Rebecca
diff mbox series

Patch

diff --git a/tools/testing/memblock/Makefile b/tools/testing/memblock/Makefile
index a698e24b35e7..9fde49ad73bd 100644
--- a/tools/testing/memblock/Makefile
+++ b/tools/testing/memblock/Makefile
@@ -45,6 +45,10 @@  help:
 	@echo  '  clean		  - Remove generated files and symlinks in the directory'
 	@echo  ''
 	@echo  'Configuration:'
+	@echo  '  make VERBOSE=1            - enable verbose output, which includes the'
+	@echo  '                              names of functions being tested and the'
+	@echo  '                              number of test cases passing'
+	@echo  '  make MEMBLOCK_DEBUG=1     - enable memblock_dbg() messages'
 	@echo  '  make NUMA=1               - simulate enabled NUMA'
 	@echo  '  make MOVABLE_NODE=1       - override `movable_node_is_enabled`'
 	@echo  '                              definition to simulate movable NUMA nodes'
diff --git a/tools/testing/memblock/README b/tools/testing/memblock/README
index ca6afcff013a..058146b528a5 100644
--- a/tools/testing/memblock/README
+++ b/tools/testing/memblock/README
@@ -34,7 +34,15 @@  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 simulate enabled NUMA, use:
+configuration parameters. For example, to include verbose output, specify the
+VERBOSE flag when building the main target:
+
+$ make VERBOSE=1
+
+This will print information about which functions are being tested and the
+number of test cases that passed.
+
+To simulate enabled NUMA, use:
 
 $ make NUMA=1
 
diff --git a/tools/testing/memblock/scripts/Makefile.include b/tools/testing/memblock/scripts/Makefile.include
index 641569ccb7b0..4401f79bed4c 100644
--- a/tools/testing/memblock/scripts/Makefile.include
+++ b/tools/testing/memblock/scripts/Makefile.include
@@ -17,3 +17,13 @@  ifeq ($(32BIT_PHYS_ADDR_T), 1)
 	CFLAGS += -m32 -U CONFIG_PHYS_ADDR_T_64BIT
 	LDFLAGS += -m32
 endif
+
+# Enable verbose testing output
+ifeq ($(VERBOSE), 1)
+	CFLAGS += -D VERBOSE
+endif
+
+# Enable memblock_dbg() messages
+ifeq ($(MEMBLOCK_DEBUG), 1)
+	CFLAGS += -D MEMBLOCK_DEBUG
+endif