← Back to branch summary

~nova-coresec/ubuntu/maverick/libvirt/nova-ppa

« back to all changes in this revision

Viewing changes to src/README

  • Committer: James Westby
  • Author(s): Guido Günther, Laurent Léonard, Guido Günther
  • Date: 2009-11-06 01:44:21 UTC
  • mfrom: (0.1.3 experimental)
  • mto: (3.4.9 squeeze)
  • mto: This revision was merged to the branch mainline in revision 58.
  • Revision ID: james.westby@canonical.com-20091106014421-dt3mlgmcukyggxex
Tags: 0.7.2-2
http://bugs.debian.org/549949
[ Laurent Léonard ]
* [a9ea205] Change requirement of libvirt-bin in libvirt- suspendonreboot.
* [a4db804] Update debian/patches/0006-Don-t-let-parent-of-daemon-
  exit-until-basic-initiali.patch. Fix use of an uninitialized variable that
  was causing a bug on i386 systems.
* [59e1e53] Redo patches.

[ Guido Günther ]
* upload to unstable
* [43f106a] Only remove masquerade roles for VIR_NETWORK_FORWARD_NAT
  (Closes: #549949) - thanks to Rob S. Wolfram for testing

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/README
 
1
       libvirt library code README
 
2
       ===========================
 
3
 
 
4
The directory provides the bulk of the libvirt codebase. Everything
 
5
except for the libvirtd daemon and client tools. The build uses a
 
6
large number of libtool convenience libraries - one for each child
 
7
directory, and then links them together for the final libvirt.so,
 
8
although some bits get linked directly to libvirtd daemon instead.
 
9
 
 
10
The files directly in this directory are supporting the public API
 
11
entry points & data structures.
 
12
 
 
13
There are two core shared modules to be aware of:
 
14
 
 
15
 * util/  - a collection of shared APIs that can be used by any
 
16
            code. This directory is always in the include path
 
17
            for all things built
 
18
 
 
19
 * conf/  - APIs for parsing / manipulating all the official XML
 
20
            files used by the public API. This directory is only
 
21
            in the include path for driver implementation modules
 
22
 
 
23
 
 
24
Then there are the hypervisor implementations:
 
25
 
 
26
 * esx/          - VMware ESX and GSX support using vSphere API over SOAP
 
27
 * lxc/          - Linux Native Containers
 
28
 * opennebula/   - Open Nebula using XMLRPC
 
29
 * openvz/       - OpenVZ containers using cli tools
 
30
 * phyp/         - IBM Power Hypervisor using CLI tools over SSH
 
31
 * qemu/         - QEMU / KVM using qemu CLI/monitor
 
32
 * remote/       - Generic libvirt native RPC client
 
33
 * test/         - A "mock" driver for testing
 
34
 * uml/          - User Mode Linux
 
35
 * vbox/         - Virtual Box using native API
 
36
 * xen/          - Xen using hypercalls, XenD SEXPR & XenStore
 
37
 
 
38
 
 
39
Finally some secondary drivers that are shared for several HVs.
 
40
Currently these are used by LXC, OpenVZ, QEMU, UML and Xen drivers.
 
41
The ESX, OpenNebula, Power Hypervisor, Remote, Test & VirtualBox
 
42
drivers all implement the secondary drivers directly
 
43
 
 
44
 * interface/    - Host network interface management
 
45
 * network/      - Virtual NAT networking
 
46
 * node_device/  - Host device enumeration
 
47
 * secret/       - Secret management
 
48
 * security/     - Mandatory access control drivers
 
49
 * storage/      - Storage management drivers
 
50
 
 
51
 
 
52
Since both the hypervisor and secondary drivers can be built as
 
53
dlopen()able modules, it is *FORBIDDEN* to have build dependencies
 
54
between these directories. Drivers are only allowed to depend on
 
55
the public API, and the internal APIs in the util/ and conf/
 
56
directories