[Libguestfs] [PATCH 7/9] Documentation: Minor cleanups to module POD
Matthew Booth
mbooth at redhat.com
Fri Feb 12 09:39:20 UTC 2010
---
lib/Sys/VirtV2V/Connection/LibVirt.pm | 7 +++----
lib/Sys/VirtV2V/Connection/LibVirtXML.pm | 2 +-
lib/Sys/VirtV2V/Converter.pm | 4 ++--
lib/Sys/VirtV2V/Converter/Linux.pm | 30 +++++++++++++++++++++++++-----
lib/Sys/VirtV2V/ExecHelper.pm | 1 -
lib/Sys/VirtV2V/GuestOS.pm | 6 +++---
lib/Sys/VirtV2V/GuestOS/RedHat.pm | 4 ++--
lib/Sys/VirtV2V/Transfer/ESX.pm | 4 ++--
8 files changed, 38 insertions(+), 20 deletions(-)
diff --git a/lib/Sys/VirtV2V/Connection/LibVirt.pm b/lib/Sys/VirtV2V/Connection/LibVirt.pm
index 59e4913..2c289b9 100644
--- a/lib/Sys/VirtV2V/Connection/LibVirt.pm
+++ b/lib/Sys/VirtV2V/Connection/LibVirt.pm
@@ -62,8 +62,8 @@ libvirt connection.
=item new(uri, name, pool)
Create a new Sys::VirtV2V::Connection::LibVirt. Domain I<name> will be
-downloaded from I<uri>. Remote storage will be copied to a new volume, which
-will be create in <pool>.
+obtained from I<uri>. Remote storage will be copied to a new volume, which
+will be created in I<pool>.
=cut
@@ -243,7 +243,7 @@ sub _get_dom
=head1 COPYRIGHT
-Copyright (C) 2009 Red Hat Inc.
+Copyright (C) 2009,2010 Red Hat Inc.
=head1 LICENSE
@@ -253,7 +253,6 @@ Please see the file COPYING.LIB for the full license.
L<Sys::VirtV2V::Connection(3)>,
L<virt-v2v(1)>,
-L<v2v-snapshot(1)>,
L<http://libguestfs.org/>.
=cut
diff --git a/lib/Sys/VirtV2V/Connection/LibVirtXML.pm b/lib/Sys/VirtV2V/Connection/LibVirtXML.pm
index 874946a..03b85b1 100644
--- a/lib/Sys/VirtV2V/Connection/LibVirtXML.pm
+++ b/lib/Sys/VirtV2V/Connection/LibVirtXML.pm
@@ -107,8 +107,8 @@ Please see the file COPYING.LIB for the full license.
=head1 SEE ALSO
+L<Sys::VirtV2V::Connection(3pm>,
L<virt-v2v(1)>,
-L<v2v-snapshot(1)>,
L<http://libguestfs.org/>.
=cut
diff --git a/lib/Sys/VirtV2V/Converter.pm b/lib/Sys/VirtV2V/Converter.pm
index edc6589..cba6db8 100644
--- a/lib/Sys/VirtV2V/Converter.pm
+++ b/lib/Sys/VirtV2V/Converter.pm
@@ -39,8 +39,8 @@ Sys::VirtV2V::Converter - Convert a guest to run on KVM
use Sys::VirtV2V::GuestOS;
use Sys::VirtV2V::Converter;
- my $guestos = Sys::VirtV2V::GuestOS->instantiate($g, $os);
- Sys::VirtV2V::Converter->convert($vmm, $guestos, $dom, $os);
+ my $guestos = Sys::VirtV2V::GuestOS->new($g, $os, $dom, $config);
+ Sys::VirtV2V::Converter->convert($vmm, $guestos, $config, $dom, $os);
=head1 DESCRIPTION
diff --git a/lib/Sys/VirtV2V/Converter/Linux.pm b/lib/Sys/VirtV2V/Converter/Linux.pm
index 4458fc3..375da48 100644
--- a/lib/Sys/VirtV2V/Converter/Linux.pm
+++ b/lib/Sys/VirtV2V/Converter/Linux.pm
@@ -46,8 +46,7 @@ Sys::VirtV2V::Converter::Linux - Convert a Linux guest to run on KVM
=head1 DESCRIPTION
-Sys::VirtV2V::Converter::Linux convert a Linux guest to use KVM. It is an
-implementation of the Sys::VirtV2V::Converter interface.
+Sys::VirtV2V::Converter::Linux converts a Linux guest to use KVM.
=head1 METHODS
@@ -55,7 +54,8 @@ implementation of the Sys::VirtV2V::Converter interface.
=item Sys::VirtV2V::Converter::Linux->can_handle(desc)
-See BACKEND INTERFACE in L<Sys::VirtV2V::Converter> for details.
+Return 1 if Sys::VirtV2V::Converter::Linux can convert the guest described by
+I<desc>, 0 otherwise.
=cut
@@ -71,7 +71,27 @@ sub can_handle
=item Sys::VirtV2V::Converter::Linux->convert(vmm, guestos, dom, desc)
-See BACKEND INTERFACE in L<Sys::VirtV2V::Converter> for details.
+Convert a Linux guest. Assume that can_handle has previously returned 1.
+
+=over
+
+=item vmm
+
+A Sys::Virt handle to the target libvirt.
+
+=item guestos
+
+An initialised Sys::VirtV2V::GuestOS for manipulating the guest OS>.
+
+=item dom
+
+A parsed XML::DOM of the guest's libvirt domain XML prior to conversion.
+
+=item desc
+
+A description of the guest OS as returned by Sys::Guestfs::Lib.
+
+=back
=cut
@@ -526,7 +546,7 @@ sub _supports_acpi
=head1 COPYRIGHT
-Copyright (C) 2009 Red Hat Inc.
+Copyright (C) 2009,2010 Red Hat Inc.
=head1 LICENSE
diff --git a/lib/Sys/VirtV2V/ExecHelper.pm b/lib/Sys/VirtV2V/ExecHelper.pm
index 29f3049..87f6d06 100644
--- a/lib/Sys/VirtV2V/ExecHelper.pm
+++ b/lib/Sys/VirtV2V/ExecHelper.pm
@@ -141,7 +141,6 @@ Please see the file COPYING.LIB for the full license.
=head1 SEE ALSO
L<virt-v2v(1)>,
-L<v2v-snapshot(1)>,
L<http://libguestfs.org/>.
=cut
diff --git a/lib/Sys/VirtV2V/GuestOS.pm b/lib/Sys/VirtV2V/GuestOS.pm
index 539659e..41dac02 100644
--- a/lib/Sys/VirtV2V/GuestOS.pm
+++ b/lib/Sys/VirtV2V/GuestOS.pm
@@ -50,9 +50,9 @@ Sys::VirtV2V::GuestOS - Manipulate and query a Guest OS
Sys::VirtV2V::GuestOS provides a mechanism for querying and manipulating a
specific guest operating system.
-Sys::VirtV2V::GuestOS is an interface to various backends, each of
-which implement a consistent API. Sys::VirtV2V::GuestOS itself only
-implements methods to access backends.
+Sys::VirtV2V::GuestOS is a virtual superclass to various backends, each of which
+implement a consistent API. The new method will actually instantiate an
+appropriate subclass.
Sys::VirtV2V::GuestOS uses L<Module::Pluggable> to automatically discover
backends under Sys::VirtV2V::GuestOS.
diff --git a/lib/Sys/VirtV2V/GuestOS/RedHat.pm b/lib/Sys/VirtV2V/GuestOS/RedHat.pm
index d6abe9b..9561338 100644
--- a/lib/Sys/VirtV2V/GuestOS/RedHat.pm
+++ b/lib/Sys/VirtV2V/GuestOS/RedHat.pm
@@ -33,7 +33,7 @@ use Locale::TextDomain 'virt-v2v';
=head1 NAME
-Sys::VirtV2V::GuestOS::RedHat - Manipulate and query a Red Hat guest
+Sys::VirtV2V::GuestOS::RedHat - Manipulate and query a Red Hat based Linux guest
=head1 SYNOPSIS
@@ -44,7 +44,7 @@ Sys::VirtV2V::GuestOS::RedHat - Manipulate and query a Red Hat guest
=head1 DESCRIPTION
Sys::VirtV2V::GuestOS::RedHat provides an interface for manipulating and
-querying a Red Hat based guest. Specifically it handles any Guest OS which
+querying a Red Hat based Linux guest. Specifically it handles any Guest OS which
Sys::Guestfs::Lib has identified as 'linux', which uses rpm as a package format.
=head1 METHODS
diff --git a/lib/Sys/VirtV2V/Transfer/ESX.pm b/lib/Sys/VirtV2V/Transfer/ESX.pm
index 353c10d..75bb3f5 100644
--- a/lib/Sys/VirtV2V/Transfer/ESX.pm
+++ b/lib/Sys/VirtV2V/Transfer/ESX.pm
@@ -327,7 +327,7 @@ sub transfer
=head1 COPYRIGHT
-Copyright (C) 2009, 2010 Red Hat Inc.
+Copyright (C) 2009,2010 Red Hat Inc.
=head1 LICENSE
@@ -335,8 +335,8 @@ Please see the file COPYING.LIB for the full license.
=head1 SEE ALSO
+L<Sys::VirtV2V::Converter>,
L<virt-v2v(1)>,
-L<v2v-snapshot(1)>,
L<http://libguestfs.org/>.
=cut
--
1.6.6
More information about the Libguestfs
mailing list