mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-07-06 09:55:46 +00:00
d672551816
Despite being a generated file, HACKING has been tracked in the git repository along with actual source files. As far as I'm aware, it's the only generated file for which that happens. Times and times again, people[1] have committed changes to the source file without refreshing the generated copy at the same time. The rationale for tracking the generated file is to help out people who just cloned the git repository looking to contribue; however, README-hacking already contains enough information to get perspective contributors to a place where they can simply look at docs/hacking.html instead. [1] Mostly me, to be honest Signed-off-by: Andrea Bolognani <abologna@redhat.com>
59 lines
1.8 KiB
Plaintext
59 lines
1.8 KiB
Plaintext
-*- outline -*-
|
|
|
|
These notes intend to help people working on the checked-out sources.
|
|
These requirements do not apply when building from a distribution tarball.
|
|
See also docs/hacking.html (after building libvirt using the information
|
|
included in this file) for more detailed contribution guidelines.
|
|
|
|
* Requirements
|
|
|
|
We've opted to keep only the highest-level sources in the GIT repository.
|
|
This eases our maintenance burden, (fewer merges etc.), but imposes more
|
|
requirements on anyone wishing to build from the just-checked-out sources.
|
|
Note the requirements to build the released archive are much less and
|
|
are just the requirements of the standard ./configure && make procedure.
|
|
Specific development tools and versions will be checked for and listed by
|
|
the bootstrap script.
|
|
|
|
Valgrind <http://valgrind.org/> is also highly recommended, if
|
|
Valgrind supports your architecture.
|
|
|
|
While building from a just-cloned source tree may require installing a
|
|
few prerequisites, later, a plain `git pull && make' should be sufficient.
|
|
|
|
* First GIT checkout
|
|
|
|
You can get a copy of the source repository like this:
|
|
|
|
$ git clone git://libvirt.org/libvirt
|
|
$ cd libvirt
|
|
|
|
As an optional step, if you already have a copy of the gnulib git
|
|
repository on your hard drive, then you can use it as a reference to
|
|
reduce download time and disk space requirements:
|
|
|
|
$ export GNULIB_SRCDIR=/path/to/gnulib
|
|
|
|
The next step is to get all required pieces from gnulib,
|
|
to run autoreconf, and to invoke ./configure:
|
|
|
|
$ ./autogen.sh
|
|
|
|
And there you are! Just
|
|
|
|
$ make
|
|
$ make check
|
|
|
|
At this point, there should be no difference between your local copy,
|
|
and the GIT master copy:
|
|
|
|
$ git diff
|
|
|
|
should output no difference.
|
|
|
|
Enjoy!
|
|
|
|
Local Variables:
|
|
indent-tabs-mode: nil
|
|
End:
|