Re: [Qemu-devel] [PATCH] Makefile: Rename the 'vm-test' target as 'vm-help'

[Stefano Garzarella <sgarzare@redhat.com>]

On Fri, May 31, 2019 at 08:43:41AM +0200, Philippe Mathieu-Daudé wrote:
> We already have 'make check-help', use the 'make vm-help' form
> to display helps about VM testing. Keep the old target to not
> bother old customs.
> 
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
> Based-on: <20190530101603.22254-1-alex.bennee@linaro.org>
>           "testing/next queue"
> ---
>  Makefile                  | 4 ++--
>  docs/devel/testing.rst    | 4 ++--
>  tests/vm/Makefile.include | 5 +++--
>  3 files changed, 7 insertions(+), 6 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index f0be624f47..f67739df7c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -9,7 +9,7 @@ SRC_PATH=.
>  UNCHECKED_GOALS := %clean TAGS cscope ctags dist \
>      html info pdf txt \
>      help check-help print-% \
> -    docker docker-% vm-test vm-build-%
> +    docker docker-% vm-help vm-test vm-build-%
>  
>  print-%:
>  	@echo '$*=$($*)'
> @@ -1121,7 +1121,7 @@ endif
>  	@echo  'Test targets:'
>  	@echo  '  check           - Run all tests (check-help for details)'
>  	@echo  '  docker          - Help about targets running tests inside Docker containers'
> -	@echo  '  vm-test         - Help about targets running tests inside VM'
> +	@echo  '  vm-help         - Help about targets running tests inside VM'
>  	@echo  ''
>  	@echo  'Documentation targets:'
>  	@echo  '  html info pdf txt'
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index da2d0fc964..68aba3926e 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -399,12 +399,12 @@ VM testing
>  
>  This test suite contains scripts that bootstrap various guest images that have
>  necessary packages to build QEMU. The basic usage is documented in ``Makefile``
> -help which is displayed with ``make vm-test``.
> +help which is displayed with ``make vm-help``.
>  
>  Quickstart
>  ----------
>  
> -Run ``make vm-test`` to list available make targets. Invoke a specific make
> +Run ``make vm-help`` to list available make targets. Invoke a specific make
>  command to run build test in an image. For example, ``make vm-build-freebsd``
>  will build the source tree in the FreeBSD image. The command can be executed
>  from either the source tree or the build dir; if the former, ``./configure`` is
> diff --git a/tests/vm/Makefile.include b/tests/vm/Makefile.include
> index 5e37063d32..b7311d7bd9 100644
> --- a/tests/vm/Makefile.include
> +++ b/tests/vm/Makefile.include
> @@ -8,8 +8,9 @@ IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES))
>  
>  .PRECIOUS: $(IMAGE_FILES)
>  
> -vm-test:
> -	@echo "vm-test: Test QEMU in preconfigured virtual machines"

What about adding something like this?
vm-test: vm-help
	@echo ""
	@echo "vm-test is deprecated, please use vm-help"

> +# 'vm-help' target was historically named 'vm-test'
> +vm-help vm-test:
> +	@echo "vm-help: Test QEMU in preconfigured virtual machines"
>  	@echo
>  	@echo "  vm-build-ubuntu.i386            - Build QEMU in ubuntu i386 VM"
>  	@echo "  vm-build-freebsd                - Build QEMU in FreeBSD VM"
> -- 
> 2.20.1
> 

With or without the vm-test message:

Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>

Thanks,
Stefano