[Qemu-devel] [PATCH 2/8] device-crash-test: Add examples to script documentation

Eduardo Habkost posted 8 patches 7 years, 7 months ago
[Qemu-devel] [PATCH 2/8] device-crash-test: Add examples to script documentation
Posted by Eduardo Habkost 7 years, 7 months ago
Add simple examples for common use cases.

Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
 scripts/device-crash-test | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/scripts/device-crash-test b/scripts/device-crash-test
index c6a7875357..364c779cdb 100755
--- a/scripts/device-crash-test
+++ b/scripts/device-crash-test
@@ -22,6 +22,25 @@
 """
 Run QEMU with all combinations of -machine and -device types,
 check for crashes and unexpected errors.
+
+Example usage:
+
+Test all QEMU binaries found in the current directory, with all
+machine-type/device combinations, but skip the combinations that are expected to
+fail:
+
+    device-crash-test
+
+Test all QEMU binaries found in the current directory, with all
+machine-type/device combinations, including the combinations that are expected
+to fail:
+
+    device-crash-test -F
+
+Test a single QEMU binary:
+
+    device-crash-test /path/to/qemu/binary
+
 """
 
 import sys
-- 
2.14.3