diff --git a/docs/source/GetStartedGuide.rst b/docs/source/GetStartedGuide.rst index e10f820..210a51f 100644 --- a/docs/source/GetStartedGuide.rst +++ b/docs/source/GetStartedGuide.rst @@ -106,7 +106,7 @@ extra parameters that you can pass:: That's right, the virt plugin gives you new options on the runner specific to -the qemu related tests. For example, you can provide ``--qemu-bin`` to tell your +the QEMU related tests. For example, you can provide ``--qemu-bin`` to tell your tests that you want a specific QEMU binary instead of whatever the runner could find looking in the system PATH or environment variables. diff --git a/docs/source/GuestConfiguration.rst b/docs/source/GuestConfiguration.rst index 2128cc3..b4a9da5 100644 --- a/docs/source/GuestConfiguration.rst +++ b/docs/source/GuestConfiguration.rst @@ -35,7 +35,7 @@ Using your own image You can use your own image by specifying the following options: * ``--guest-image-path`` - You can provide this option with an arbitrary path - to a qemu disk image file with your guest. You can use any of the file formats + to a QEMU disk image file with your guest. You can use any of the file formats specified, such as qcow2, qed or even raw image formats. * ``--guest-user`` - If your image has a specific user set up previously that diff --git a/docs/source/Introduction.rst b/docs/source/Introduction.rst index d60ebc2..91b4d4e 100644 --- a/docs/source/Introduction.rst +++ b/docs/source/Introduction.rst @@ -7,4 +7,4 @@ Introduction Avocado-virt is a plugin for the Avocado Test Framework. It aims to provide libraries and extra functionality necessary to run virtualization tests on Linux. We started with KVM/QEMU, but we're certainly open to expand the coverage -to things like Xen, and libvirt. +to things like Xen and libvirt. diff --git a/docs/source/ReferenceGuide.rst b/docs/source/ReferenceGuide.rst index 87c0360..97c57ce 100644 --- a/docs/source/ReferenceGuide.rst +++ b/docs/source/ReferenceGuide.rst @@ -18,37 +18,37 @@ file. Table of supported params: -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| Params path | Params key | Description | -+================================+================================+==================================================================================+ -| /plugins/virt/guest/* | disable_restore_image_test | Don't restore the image after each test | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/guest/* | image_path | Path to the guest image | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/guest/* | password | Guest remote login password | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/guest/* | shell_prompt | Regexp of the guest remote command line | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/guest/* | user | Guest remote login name | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/qemu/migrate/* | timeout | Migration timeout | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/qemu/paths/* | qemu_bin | Qemu binary path | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/qemu/paths/* | qemu_img_bin | Qemu-img binary path | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/qemu/paths/* | qemu_io_bin | Qemu-io binary path | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/qemu/template/* | contents | Template of the qemu command to be run instead of autogenerated one | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/screendumps/* | enable | Enable screendump service | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/screendumps/* | interval | Interval between screendumps | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/videos/* | enable | Encode screendumps into video after the test | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ -| /plugins/virt/videos/* | jpeg_quality | Quality of the screendump image postprocessing | -+--------------------------------+--------------------------------+----------------------------------------------------------------------------------+ ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| Params path | Params key | Description | ++===============================+============================+=====================================================================+ +| /plugins/virt/guest/* | disable_restore_image_test | Don't restore the image after each test | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/guest/* | image_path | Path to the guest image | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/guest/* | password | Guest remote login password | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/guest/* | shell_prompt | Regexp of the guest remote command line | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/guest/* | user | Guest remote login name | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/qemu/migrate/* | timeout | Migration timeout | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/qemu/paths/* | qemu_bin | Path to the QEMU executable file | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/qemu/paths/* | qemu_img_bin | Path to the qemu-img executable file | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/qemu/paths/* | qemu_io_bin | Path to the qemu-io executable file | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/qemu/template/* | contents | Template of the QEMU command to be run instead of autogenerated one | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/screendumps/* | enable | Enable screendump service | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/screendumps/* | interval | Interval between screendumps | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/videos/* | enable | Encode screendumps into video after the test | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ +| /plugins/virt/videos/* | jpeg_quality | Quality of the screendump image postprocessing | ++-------------------------------+----------------------------+---------------------------------------------------------------------+ .. note:: Some of these values can be modified in config files and/or overridden on the command line. To view the setting on your system run @@ -58,4 +58,4 @@ Table of supported params: other or on features touched in the test (for example when your test doesn't use qemu-io executing the test with various values makes no sense. Changing the qemu_bin on the other hand makes the test executed on - different qemu versions.) + different QEMU versions.)