README

   1 virt-what
   2 Copyright (C) 2008-2011 Red Hat Inc.
   3 ----------------------------------------------------------------------
   4
   5 This is a collection of scripts which you can use to work out what
   6 sort of virtualization you are running inside.  Please read the manual
   7 page virt-what(1) to find out how to use it.  This file is for
   8 developers and people compiling from source.
   9
  10 Compiling and installing
  11 ----------------------------------------------------------------------
  12
  13 Build:
  14
  15   ./configure
  16   make
  17
  18 If you want to run the automated tests:
  19
  20   make check
  21
  22 If you want to run it from the local directory, then you have to set
  23 the PATH:
  24
  25   PATH=.:$PATH virt-what
  26
  27 or since virt-what normally needs to be run as root:
  28
  29   su -c 'PATH=.:$PATH virt-what'
  30
  31 To install (usually as root):
  32
  33   make install
  34
  35 also:
  36
  37   make prefix=/usr install
  38   make DESTDIR=/tmp/somewhere install
  39
  40 Contributing a virtualization test
  41 ----------------------------------------------------------------------
  42
  43 virt-what is especially dependent on outside contributors because it's
  44 hard to even get access to some of the hypervisors out there, and even
  45 for the common hypervisors there are many different versions and many
  46 different ways for to break.  For these reasons we are especially
  47 happy if you contribute to or even just test virt-what :-)
  48
  49 virt-what is a simple shell script.  Add a new hypervisor test to
  50 'virt-what.in' ('virt-what' in this directory is a generated file).
  51
  52 If you can't contribute a patch, please just send us the following
  53 data (all as root from inside the guest):
  54
  55   (1) /proc/cpuinfo
  56
  57   (2) dmidecode
  58
  59   (3) If possible, send the output of /usr/libexec/virt-what-cpuid-helper
  60
  61   (4) Any other /proc and /sys files that may be related to the
  62       hypervisor.
  63
  64   (5) Name of the virtualization system, version, host or guest,
  65       and as much other information as possible.
  66
  67 Please send patches, test results or any other data to:
  68
  69   https://www.redhat.com/mailman/listinfo/virt-tools-list
  70
  71 See also: http://virt-tools.org/contact/
  72
  73 Contributing a regression test
  74 ----------------------------------------------------------------------
  75
  76 In the tests/ subdirectory you'll find some existing tests.
  77
  78 These tests are taken from real machines, and we have a policy of
  79 *only* adding real data here so that our regression tests are
  80 impeccable.
  81
  82 The virt-what script has a hidden '--test-root' option which allows a
  83 different root directory to be specified for these regression tests.
  84 The tests/ subdirectory contains some alternate root filesystems
  85 (sparsely populated with a few files taken from the real systems) for
  86 testing.