diff mbox

[v2] build: disarm the TCG unit test trap

Message ID 20171121142538.22072-1-berrange@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

Daniel P. Berrangé Nov. 21, 2017, 2:25 p.m. UTC
Developers sometimes mistakenly run 'make test' instead of 'make check'.
'make test' triggers the ancient, unmaintained tcg unit tests in
tests/tcg/Makefile which have long since ceased compiling.

Even if someone fixes the TCG tests, it makes little sense to put
them in a 'make test' target, rather they should be 'make check-tcg',
possibly wired up as a dependency of 'make check'.

In the meantime, this patch disarms the 'make test' trap by simply
deleting it so users get an immediate error. This should be enough
for them to remember to type 'make check' instead (or 'make help'
to learn). It also deletes 'make speed' which is another route
into the tcg tests.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
---

Changed in v2:

 - Remove 'test' & 'speed' targets, instead of making 'test'
   a synonym for 'check'

 Makefile | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

Comments

Kashyap Chamarthy Nov. 21, 2017, 3 p.m. UTC | #1
On Tue, Nov 21, 2017 at 02:25:38PM +0000, Daniel P. Berrange wrote:
> Developers sometimes mistakenly run 'make test' instead of 'make check'.
> 'make test' triggers the ancient, unmaintained tcg unit tests in
> tests/tcg/Makefile which have long since ceased compiling.
> 
> Even if someone fixes the TCG tests, it makes little sense to put
> them in a 'make test' target, rather they should be 'make check-tcg',
> possibly wired up as a dependency of 'make check'.
> 
> In the meantime, this patch disarms the 'make test' trap by simply
> deleting it so users get an immediate error. This should be enough
> for them to remember to type 'make check' instead (or 'make help'
> to learn). It also deletes 'make speed' which is another route
> into the tcg tests.

Thanks; I mistakenly fell for this trap.

> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> ---
> 
> Changed in v2:
> 
>  - Remove 'test' & 'speed' targets, instead of making 'test'
>    a synonym for 'check'
> 
>  Makefile | 6 +-----
>  1 file changed, 1 insertion(+), 5 deletions(-)

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>

[...]
Daniel Henrique Barboza Nov. 21, 2017, 3:05 p.m. UTC | #2
Reviewed-by: Daniel Henrique Barboza <danielhb@linux.vnet.ibm.com>

On 11/21/2017 12:25 PM, Daniel P. Berrange wrote:
> Developers sometimes mistakenly run 'make test' instead of 'make check'.
> 'make test' triggers the ancient, unmaintained tcg unit tests in
> tests/tcg/Makefile which have long since ceased compiling.
>
> Even if someone fixes the TCG tests, it makes little sense to put
> them in a 'make test' target, rather they should be 'make check-tcg',
> possibly wired up as a dependency of 'make check'.
>
> In the meantime, this patch disarms the 'make test' trap by simply
> deleting it so users get an immediate error. This should be enough
> for them to remember to type 'make check' instead (or 'make help'
> to learn). It also deletes 'make speed' which is another route
> into the tcg tests.
>
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> ---
>
> Changed in v2:
>
>   - Remove 'test' & 'speed' targets, instead of making 'test'
>     a synonym for 'check'
>
>   Makefile | 6 +-----
>   1 file changed, 1 insertion(+), 5 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index d2e31d98af..ab0354c153 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -253,7 +253,7 @@ Makefile: ;
>   configure: ;
>
>   .PHONY: all clean cscope distclean html info install install-doc \
> -	pdf txt recurse-all speed test dist msi FORCE
> +	pdf txt recurse-all dist msi FORCE
>
>   $(call set-vpath, $(SRC_PATH))
>
> @@ -716,10 +716,6 @@ endif
>   	$(MAKE) $(SUBDIR_MAKEFLAGS) TARGET_DIR=$$d/ -C $$d $@ || exit 1 ; \
>           done
>
> -# various test targets
> -test speed: all
> -	$(MAKE) -C tests/tcg $@
> -
>   .PHONY: ctags
>   ctags:
>   	rm -f tags
Philippe Mathieu-Daudé Nov. 21, 2017, 3:31 p.m. UTC | #3
On 11/21/2017 11:25 AM, Daniel P. Berrange wrote:
> Developers sometimes mistakenly run 'make test' instead of 'make check'.
> 'make test' triggers the ancient, unmaintained tcg unit tests in
> tests/tcg/Makefile which have long since ceased compiling.
> 
> Even if someone fixes the TCG tests, it makes little sense to put
> them in a 'make test' target, rather they should be 'make check-tcg',
> possibly wired up as a dependency of 'make check'.
> 
> In the meantime, this patch disarms the 'make test' trap by simply
> deleting it so users get an immediate error. This should be enough
> for them to remember to type 'make check' instead (or 'make help'
> to learn). It also deletes 'make speed' which is another route
> into the tcg tests.
> 
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>

> ---
> 
> Changed in v2:
> 
>  - Remove 'test' & 'speed' targets, instead of making 'test'
>    a synonym for 'check'
> 
>  Makefile | 6 +-----
>  1 file changed, 1 insertion(+), 5 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index d2e31d98af..ab0354c153 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -253,7 +253,7 @@ Makefile: ;
>  configure: ;
>  
>  .PHONY: all clean cscope distclean html info install install-doc \
> -	pdf txt recurse-all speed test dist msi FORCE
> +	pdf txt recurse-all dist msi FORCE
>  
>  $(call set-vpath, $(SRC_PATH))
>  
> @@ -716,10 +716,6 @@ endif
>  	$(MAKE) $(SUBDIR_MAKEFLAGS) TARGET_DIR=$$d/ -C $$d $@ || exit 1 ; \
>          done
>  
> -# various test targets
> -test speed: all
> -	$(MAKE) -C tests/tcg $@
> -
>  .PHONY: ctags
>  ctags:
>  	rm -f tags
>
Peter Maydell Nov. 21, 2017, 3:50 p.m. UTC | #4
On 21 November 2017 at 14:25, Daniel P. Berrange <berrange@redhat.com> wrote:
> Developers sometimes mistakenly run 'make test' instead of 'make check'.
> 'make test' triggers the ancient, unmaintained tcg unit tests in
> tests/tcg/Makefile which have long since ceased compiling.
>
> Even if someone fixes the TCG tests, it makes little sense to put
> them in a 'make test' target, rather they should be 'make check-tcg',
> possibly wired up as a dependency of 'make check'.
>
> In the meantime, this patch disarms the 'make test' trap by simply
> deleting it so users get an immediate error. This should be enough
> for them to remember to type 'make check' instead (or 'make help'
> to learn). It also deletes 'make speed' which is another route
> into the tcg tests.
>
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> ---
>

Applied to master, thanks (will be nice to stop having to
tell people about this one :-))

-- PMM
diff mbox

Patch

diff --git a/Makefile b/Makefile
index d2e31d98af..ab0354c153 100644
--- a/Makefile
+++ b/Makefile
@@ -253,7 +253,7 @@  Makefile: ;
 configure: ;
 
 .PHONY: all clean cscope distclean html info install install-doc \
-	pdf txt recurse-all speed test dist msi FORCE
+	pdf txt recurse-all dist msi FORCE
 
 $(call set-vpath, $(SRC_PATH))
 
@@ -716,10 +716,6 @@  endif
 	$(MAKE) $(SUBDIR_MAKEFLAGS) TARGET_DIR=$$d/ -C $$d $@ || exit 1 ; \
         done
 
-# various test targets
-test speed: all
-	$(MAKE) -C tests/tcg $@
-
 .PHONY: ctags
 ctags:
 	rm -f tags