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