summaryrefslogtreecommitdiffstats
path: root/perl/README
diff options
context:
space:
mode:
authorRichard Jones <rjones@trick.home.annexia.org>2009-07-09 14:01:58 +0100
committerRichard Jones <rjones@trick.home.annexia.org>2009-07-09 15:33:26 +0100
commit2f70ca487bee8babe5aef27f00a2131ea86ebd50 (patch)
treec1271a5ea3317b2e8851d2302b9d5b15fa770652 /perl/README
parente3c2a599027f88a617b46b77be1673de0c94faee (diff)
downloadlibguestfs-2f70ca487bee8babe5aef27f00a2131ea86ebd50.tar.gz
libguestfs-2f70ca487bee8babe5aef27f00a2131ea86ebd50.tar.xz
libguestfs-2f70ca487bee8babe5aef27f00a2131ea86ebd50.zip
Add Sys::Guestfs::Lib - useful functions for using libguestfs from Perl.
This adds an extra Perl module called Sys::Guestfs::Lib which adds useful functions for using libguestfs from Perl. The intention is that common code shared between virt-inspector, virt-df and virt-v2v will move into this library. This patch also changes virt-inspector to use this library.
Diffstat (limited to 'perl/README')
-rw-r--r--perl/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/perl/README b/perl/README
new file mode 100644
index 00000000..6d7d6460
--- /dev/null
+++ b/perl/README
@@ -0,0 +1,20 @@
+Sys::Guestfs
+------------
+
+This directory contains the Perl bindings for the libguestfs API.
+
+The basic libguestfs bindings have the name 'Sys::Guestfs'.
+
+As with all other language bindings, these bindings are generated
+automatically. See src/generator.ml.
+
+Sys::Guestfs::Lib
+-----------------
+
+Because we use Perl for writing lots of additional tools around
+libguestfs, the Perl bindings also contain an extra library of useful
+functions, called 'Sys::Guestfs::Lib'. This extra library is entirely
+optional, and only enhances the usefulness of the ordinary libguestfs
+API.
+
+One of the features of this library is tighter libvirt integration.