diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2011-01-18 22:29:43 +0000 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2011-01-18 22:29:43 +0000 |
commit | 5a0ed24f5002766bb4938123cfe1e1551d9d0f0a (patch) | |
tree | 38a9b51df8700da6eac4677ef9a6dee6d13183f3 | |
parent | 77e1dc20cad7b20b5c9365e0dcc1bc9344cc8faf (diff) | |
download | virt-what-5a0ed24f5002766bb4938123cfe1e1551d9d0f0a.tar.gz virt-what-5a0ed24f5002766bb4938123cfe1e1551d9d0f0a.tar.xz virt-what-5a0ed24f5002766bb4938123cfe1e1551d9d0f0a.zip |
Update README with information for potential contributors.
-rw-r--r-- | README | 57 |
1 files changed, 55 insertions, 2 deletions
@@ -1,9 +1,14 @@ virt-what -Copyright (C) 2008-2009 Red Hat Inc. +Copyright (C) 2008-2011 Red Hat Inc. ---------------------------------------------------------------------- This is a collection of scripts which you can use to work out what -sort of virtualization you are running inside. +sort of virtualization you are running inside. Please read the manual +page virt-what(1) to find out how to use it. This file is for +developers and people compiling from source. + +Compiling and installing +---------------------------------------------------------------------- Build: @@ -31,3 +36,51 @@ also: make prefix=/usr install make DESTDIR=/tmp/somewhere install + +Contributing a virtualization test +---------------------------------------------------------------------- + +virt-what is especially dependent on outside contributors because it's +hard to even get access to some of the hypervisors out there, and even +for the common hypervisors there are many different versions and many +different ways for to break. For these reasons we are especially +happy if you contribute to or even just test virt-what :-) + +virt-what is a simple shell script. Add a new hypervisor test to +'virt-what.in' ('virt-what' in this directory is a generated file). + +If you can't contribute a patch, please just send us the following +data (all as root from inside the guest): + + (1) /proc/cpuinfo + + (2) dmidecode + + (3) If possible, send the output of /usr/libexec/virt-what-cpuid-helper + + (4) Any other /proc and /sys files that may be related to the + hypervisor. + + (5) Name of the virtualization system, version, host or guest, + and as much other information as possible. + +Please send patches, test results or any other data to: + + https://www.redhat.com/mailman/listinfo/virt-tools-list + +See also: http://virt-tools.org/contact/ + +Contributing a regression test +---------------------------------------------------------------------- + +In the tests/ subdirectory you'll find some existing tests. + +These tests are taken from real machines, and we have a policy of +*only* adding real data here so that our regression tests are +impeccable. + +The virt-what script has a hidden '--test-root' option which allows a +different root directory to be specified for these regression tests. +The tests/ subdirectory contains some alternate root filesystems +(sparsely populated with a few files taken from the real systems) for +testing. |