Add -m/--machine option.
[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
10   qemu-sanity-check
11
12 Test a given qemu binary with a given Linux kernel (you can omit
13 either option):
14
15   qemu-sanity-check --qemu=/path/to/qemu --kernel=/path/to/vmlinuz
16
17 License
18 -------
19
20 The shell script is licensed under the GNU General Public License,
21 version 2 or (at your option) a later version.  See 'COPYING' for the
22 full license.
23
24 Author
25 ------
26
27 Richard W.M. Jones <rjones@redhat.com>
28
29 Building
30 --------
31
32 Requirements:
33
34   bash - to run the script
35
36   gcc - to compile the helper program
37
38   static libc - to link the helper program statically
39
40   cpio - to build the initramfs
41
42   qemu and/or Linux kernel - something to test
43
44   pod2man (from Perl) - if you want to build the manual page
45
46 To build:
47
48   From git:                     From tarball:
49     autoreconf -i
50     ./configure                   ./configure
51     make                          make
52     make check                    make check
53
54 Developers
55 ----------
56
57 Upstream git repository is:
58 http://git.annexia.org/?p=qemu-sanity-check.git;a=summary
59
60 Please send patches etc to the qemu-devel mailing list:
61 https://lists.nongnu.org/mailman/listinfo/qemu-devel
62 (but also CC the author).