README 1.79 KB
Newer Older
1
2
3
4
5
6
Welcome to kvm-unit-tests

See http://www.linux-kvm.org/page/KVM-unit-tests for a high-level
description of this project, as well as running tests and adding
tests HOWTOs.

7
8
This directory contains sources for a kvm test suite.

Andrew Jones's avatar
Andrew Jones committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
To create the test images do
  ./configure
  make
in this directory. Test images are created in ./<ARCH>/*.flat

Then use the runner script to detect the correct invocation and
invoke the test, e.g.
  ./x86-run ./x86/msr.flat
or
  ./run_tests.sh
to run them all.

To select a specific qemu binary, specify the QEMU=<path>
environment variable, e.g.
  QEMU=/tmp/qemu/x86_64-softmmu/qemu-system-x86_64 ./x86-run ./x86/msr.flat
24

25
26
27
28
29
30
31
32
33
34
To create and use standalone tests do
  ./configure
  make standalone
  (send tests/some-test somewhere)
  (go to somewhere)
  ./some-test

'make install' will install all tests in PREFIX/share/kvm-unit-tests/tests,
each as a standalone test.

35
Directory structure:
Andrew Jones's avatar
Andrew Jones committed
36
37
38
39
40
41
42
43
.:		configure script, top-level Makefile, and run_tests.sh
./config:	collection of architecture dependent makefiles
./docs:		documentation files
./lib:		general architecture neutral services for the tests
./lib/<ARCH>:	architecture dependent services for the tests
./<ARCH>:	the sources of the tests and the created objects/images

See <ARCH>/README for architecture specific documentation.
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

CONTRIBUTING:
=============

Style
-----

Currently there is a mix of indentation styles so any changes to
existing files should be consistent with the existing style. For new
files:

  - C: please use standard linux-with-tabs
  - Shell: use TABs for indentation

Patches
-------

Patches are welcome at the KVM mailing list <kvm@vger.kernel.org>.

Please prefix messages with: [kvm-unit-tests PATCH]

You can add the following to .git/config to do this automatically for you:

[format]
	subjectprefix = kvm-unit-tests PATCH