README-hacking

   1 -*- outline -*-
   2
   3 These notes intend to help people working on the checked-out sources.
   4 These requirements do not apply when building from a distribution tarball.
   5 See also HACKING for more detailed libvirt contribution guidelines.
   6
   7 * Requirements
   8
   9 We've opted to keep only the highest-level sources in the GIT repository.
  10 This eases our maintenance burden, (fewer merges etc.), but imposes more
  11 requirements on anyone wishing to build from the just-checked-out sources.
  12 Note the requirements to build the released archive are much less and
  13 are just the requirements of the standard ./configure && make procedure.
  14 Specific development tools and versions will be checked for and listed by
  15 the bootstrap script.
  16
  17 Valgrind <http://valgrind.org/> is also highly recommended, if
  18 Valgrind supports your architecture. See also README-valgrind.
  19
  20 While building from a just-cloned source tree may require installing a
  21 few prerequisites, later, a plain `git pull && make' should be sufficient.
  22
  23 * First GIT checkout
  24
  25 You can get a copy of the source repository like this:
  26
  27         $ git clone git://libvirt.org/libvirt
  28         $ cd libvirt
  29
  30 As an optional step, if you already have a copy of the gnulib git
  31 repository on your hard drive, then you can use it as a reference to
  32 reduce download time and disk space requirements:
  33
  34         $ export GNULIB_SRCDIR=/path/to/gnulib
  35
  36 The next step is to get all required pieces from gnulib,
  37 to run autoreconf, and to invoke ./configure:
  38
  39         $ ./autogen.sh
  40
  41 And there you are!  Just
  42
  43         $ make
  44         $ make check
  45
  46 At this point, there should be no difference between your local copy,
  47 and the GIT master copy:
  48
  49         $ git diff
  50
  51 should output no difference.
  52
  53 Enjoy!
  54
  55 Local Variables:
  56 indent-tabs-mode: nil
  57 End: