Skip to contentSkip to conversation

Makefile: Rename the 'vm-test' target as 'vm-help'

PATCH In review Philippe Mathieu-Daudé 3 participants 5 messages May 31, 2019 – Jun 24, 2019 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Makefile: Rename the 'vm-test' target as 'vm-help'

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.

---
Based-on: <[email protected]>
"testing/next queue"

---
 Makefile                  | 4 ++--
 docs/devel/testing.rst    | 4 ++--
 tests/vm/Makefile.include | 5 +++--
 3 files changed, 7 insertions(+), 6 deletions(-)
Makefile +2 -2
index f0be624f47..f67739df7c 100644
@@ -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'
docs/devel/testing.rst +2 -2
index da2d0fc964..68aba3926e 100644
@@ -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
tests/vm/Makefile.include +3 -2
index 5e37063d32..b7311d7bd9 100644
@@ -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"
+# '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"
Signature · 1 line
2.20.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 60 lines · Philippe Mathieu-Daudé

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.

---
Based-on: <[email protected]>
"testing/next queue"

---
 Makefile                  | 4 ++--
 docs/devel/testing.rst    | 4 ++--
 tests/vm/Makefile.include | 5 +++--
 3 files changed, 7 insertions(+), 6 deletions(-)
Makefile +2 -2
index f0be624f47..f67739df7c 100644
@@ -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'
docs/devel/testing.rst +2 -2
index da2d0fc964..68aba3926e 100644
@@ -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
tests/vm/Makefile.include +0 -0
index 5e37063d32..b7311d7bd9 100644

tests/vm/Makefile.include IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES)) · line 12

Quoted 5 lines
tests/vm/Makefile.include +0 -2
@@ -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"
Quoted 9 lines
tests/vm/Makefile.include +3 -0
+# '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"
Signature · 1 line
2.20.1

With or without the vm-test message:

Thanks,
Stefano

#2 lore raw

Hi Stefano,

Quoted 64 lines · Stefano Garzarella
Quoted 63 lines · Philippe Mathieu-Daudé

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.

---
Based-on: <[email protected]>
"testing/next queue"

---
 Makefile                  | 4 ++--
 docs/devel/testing.rst    | 4 ++--
 tests/vm/Makefile.include | 5 +++--
 3 files changed, 7 insertions(+), 6 deletions(-)
Makefile +2 -2
index f0be624f47..f67739df7c 100644
@@ -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'
docs/devel/testing.rst +2 -2
index da2d0fc964..68aba3926e 100644
@@ -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
tests/vm/Makefile.include +0 -0
index 5e37063d32..b7311d7bd9 100644
@@ -8,8 +8,9 @@ IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES))
 
 .PRECIOUS: $(IMAGE_FILES)
 
Quoted 7 lines

tests/vm/Makefile.include IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES)) · line 12

Quoted 2 lines
tests/vm/Makefile.include +0 -2
-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"

I wouldn't worry about deprecation warnings for dev tools, it would be just noise :)

Quoted 13 lines
Quoted 10 lines
tests/vm/Makefile.include +3 -0
+# '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"
Signature · 1 line
2.20.1

With or without the vm-test message:

Quoted 1 line

Thanks!

Phil.

#3 lore raw
Quoted 75 lines · Philippe Mathieu-Daudé

Hi Stefano,

Quoted 64 lines · Stefano Garzarella
Quoted 63 lines · Philippe Mathieu-Daudé

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.

---
Based-on: <[email protected]>
"testing/next queue"

---
 Makefile                  | 4 ++--
 docs/devel/testing.rst    | 4 ++--
 tests/vm/Makefile.include | 5 +++--
 3 files changed, 7 insertions(+), 6 deletions(-)
Makefile +2 -2
index f0be624f47..f67739df7c 100644
@@ -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'
docs/devel/testing.rst +2 -2
index da2d0fc964..68aba3926e 100644
@@ -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
tests/vm/Makefile.include +0 -0
index 5e37063d32..b7311d7bd9 100644
@@ -8,8 +8,9 @@ IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES))
 
 .PRECIOUS: $(IMAGE_FILES)
 
Quoted 7 lines

tests/vm/Makefile.include IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES)) · line 12

Quoted 2 lines
tests/vm/Makefile.include +0 -2
-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"
Quoted 2 lines

I wouldn't worry about deprecation warnings for dev tools, it would be just noise :)

Make sense :)

Cheers,
Stefano

#4 lore raw
In reply to Philippe Mathieu-Daudé
Quoted 5 lines · Philippe Mathieu-Daudé

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.

Queued to testing/next, thanks.

Quoted 56 lines

---
Based-on: <[email protected]>
"testing/next queue"

---
 Makefile                  | 4 ++--
 docs/devel/testing.rst    | 4 ++--
 tests/vm/Makefile.include | 5 +++--
 3 files changed, 7 insertions(+), 6 deletions(-)
Makefile +2 -2
index f0be624f47..f67739df7c 100644
@@ -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'
docs/devel/testing.rst +2 -2
index da2d0fc964..68aba3926e 100644
@@ -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
tests/vm/Makefile.include +0 -0
index 5e37063d32..b7311d7bd9 100644
@@ -8,8 +8,9 @@ IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES))
 

tests/vm/Makefile.include IMAGE_FILES := $(patsubst %, $(IMAGES_DIR)/%.img, $(IMAGES)) · line 16

Quoted 10 lines
tests/vm/Makefile.include +3 -2
 .PRECIOUS: $(IMAGE_FILES)
 
-vm-test:
-	@echo "vm-test: Test QEMU in preconfigured virtual machines"
+# '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"

--
Alex Bennée