src: Look for kernels in /lib/modules/*/vmlinuz
[qemu-sanity-check.git] / README
1 qemu-sanity-check is a short shell script that test-boots a Linux
2 kernel under qemu, making sure it boots up to userspace.  The idea is
3 to test the Linux kernel and/or qemu to make sure they are working.
4
5 Please read the qemu-sanity-check(1) man page, but basic usage is very
6 simple.  You probably want to use one of the following commands:
7
8 Test qemu on path against most recent installed Linux kernel in /boot
9 (or /lib/modules/VERSION/vmlinuz on some distros):
10
11   qemu-sanity-check
12
13 Test a given qemu binary with a given Linux kernel (you can omit
14 either option):
15
16   qemu-sanity-check --qemu=/path/to/qemu --kernel=/path/to/vmlinuz
17
18 License
19 -------
20
21 The shell script is licensed under the GNU General Public License,
22 version 2 or (at your option) a later version.  See 'COPYING' for the
23 full license.
24
25 Author
26 ------
27
28 Richard W.M. Jones <rjones@redhat.com>
29
30 Building
31 --------
32
33 Requirements:
34
35   bash - to run the script
36
37   gcc - to compile the helper program
38
39   static libc - to link the helper program statically
40
41   cpio - to build the initramfs
42
43   qemu and/or Linux kernel - something to test
44
45   pod2man (from Perl) - if you want to build the manual page
46
47 To build:
48
49   From git:                     From tarball:
50     autoreconf -i
51     ./configure                   ./configure
52     make                          make
53     make check                    make check
54
55 Developers
56 ----------
57
58 Upstream git repository is:
59 http://git.annexia.org/?p=qemu-sanity-check.git;a=summary
60
61 Please send patches etc to the qemu-devel mailing list:
62 https://lists.nongnu.org/mailman/listinfo/qemu-devel
63 (but also CC the author).