From nobody Sat Apr 20 02:47:07 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1520361195846670.2267480599045; Tue, 6 Mar 2018 10:33:15 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 99084356E2; Tue, 6 Mar 2018 18:33:13 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 51FEE600C9; Tue, 6 Mar 2018 18:33:13 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id D6CB218033ED; Tue, 6 Mar 2018 18:33:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w26IXANa008957 for ; Tue, 6 Mar 2018 13:33:10 -0500 Received: by smtp.corp.redhat.com (Postfix) id 0058C1C71C; Tue, 6 Mar 2018 18:33:10 +0000 (UTC) Received: from vhost2.laine.org (ovpn-116-195.phx2.redhat.com [10.3.116.195]) by smtp.corp.redhat.com (Postfix) with ESMTP id 481CD1C723 for ; Tue, 6 Mar 2018 18:33:09 +0000 (UTC) From: Laine Stump To: libvir-list@redhat.com Date: Tue, 6 Mar 2018 13:33:00 -0500 Message-Id: <20180306183302.522518-2-laine@laine.org> In-Reply-To: <20180306183302.522518-1-laine@laine.org> References: <20180306183302.522518-1-laine@laine.org> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-loop: libvir-list@redhat.com Subject: [libvirt] [perl PATCH 1/3] docs: replace $vmm with $conn X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Tue, 06 Mar 2018 18:33:14 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" This is more in line with the naming in C language examples, and within libvirt's own code. Signed-off-by: Laine Stump Reviewed-by: Daniel P. Berrang=C3=A9 --- lib/Sys/Virt.pm | 188 ++++++++++++++++++++++++++++------------------------= ---- 1 file changed, 94 insertions(+), 94 deletions(-) diff --git a/lib/Sys/Virt.pm b/lib/Sys/Virt.pm index 035cdb6..6a643fa 100644 --- a/lib/Sys/Virt.pm +++ b/lib/Sys/Virt.pm @@ -25,9 +25,9 @@ Sys::Virt - Represent and manage a libvirt hypervisor con= nection =20 =3Dhead1 SYNOPSIS =20 - my $vmm =3D Sys::Virt->new(uri =3D> $uri); + my $conn =3D Sys::Virt->new(uri =3D> $uri); =20 - my @domains =3D $vmm->list_domains(); + my @domains =3D $conn->list_domains(); =20 foreach my $dom (@domains) { print "Domain ", $dom->get_id, " ", $dom->get_name, "\n"; @@ -47,7 +47,7 @@ will result in an instance of the L mod= ule being thrown. To catch these errors, simply wrap the method in an eval block: =20 - eval { my $vmm =3D Sys::Virt->new(uri =3D> $uri); }; + eval { my $conn =3D Sys::Virt->new(uri =3D> $uri); }; if ($@) { print STDERR "Unable to open connection to $addr" . $@->message . "\n"; } @@ -82,7 +82,7 @@ our $VERSION =3D '4.2.0'; require XSLoader; XSLoader::load('Sys::Virt', $VERSION); =20 -=3Ditem my $vmm =3D Sys::Virt->new(uri =3D> $uri, readonly =3D> $ro, flags= =3D> $flags); +=3Ditem my $conn =3D Sys::Virt->new(uri =3D> $uri, readonly =3D> $ro, flag= s =3D> $flags); =20 Attach to the virtualization host identified by C. The C parameter may be omitted, in which case the default connection made @@ -207,7 +207,7 @@ sub new { } =20 =20 -=3Ditem my $st =3D $vmm->new_stream($flags) +=3Ditem my $st =3D $conn->new_stream($flags) =20 Create a new stream, with the given flags =20 @@ -221,7 +221,7 @@ sub new_stream { } =20 =20 -=3Ditem my $dom =3D $vmm->create_domain($xml, $flags); +=3Ditem my $dom =3D $conn->create_domain($xml, $flags); =20 Create a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -239,7 +239,7 @@ sub create_domain { return Sys::Virt::Domain->_new(connection =3D> $self, xml =3D> $xml, f= lags =3D> $flags); } =20 -=3Ditem my $dom =3D $vmm->create_domain_with_files($xml, $fds, $flags); +=3Ditem my $dom =3D $conn->create_domain_with_files($xml, $fds, $flags); =20 Create a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -262,7 +262,7 @@ sub create_domain_with_files { fds =3D> $fds, flags =3D> $flags); } =20 -=3Ditem my $dom =3D $vmm->define_domain($xml, $flags=3D0); +=3Ditem my $dom =3D $conn->define_domain($xml, $flags=3D0); =20 Defines, but does not start, a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -281,7 +281,7 @@ sub define_domain { return Sys::Virt::Domain->_new(connection =3D> $self, xml =3D> $xml, n= ocreate =3D> 1, flags =3D> $flags); } =20 -=3Ditem my $dom =3D $vmm->create_network($xml); +=3Ditem my $dom =3D $conn->create_network($xml); =20 Create a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -297,7 +297,7 @@ sub create_network { return Sys::Virt::Network->_new(connection =3D> $self, xml =3D> $xml); } =20 -=3Ditem my $dom =3D $vmm->define_network($xml); +=3Ditem my $dom =3D $conn->define_network($xml); =20 Defines, but does not start, a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -315,7 +315,7 @@ sub define_network { return Sys::Virt::Network->_new(connection =3D> $self, xml =3D> $xml, = nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $vmm->create_storage_pool($xml); +=3Ditem my $dom =3D $conn->create_storage_pool($xml); =20 Create a new storage pool based on the XML description passed into the C<$= xml> parameter. The returned object is an instance of the L @@ -331,7 +331,7 @@ sub create_storage_pool { return Sys::Virt::StoragePool->_new(connection =3D> $self, xml =3D> $x= ml); } =20 -=3Ditem my $dom =3D $vmm->define_storage_pool($xml); +=3Ditem my $dom =3D $conn->define_storage_pool($xml); =20 Defines, but does not start, a new storage pol based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -349,7 +349,7 @@ sub define_storage_pool { return Sys::Virt::StoragePool->_new(connection =3D> $self, xml =3D> $x= ml, nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $vmm->create_interface($xml); +=3Ditem my $dom =3D $conn->create_interface($xml); =20 Create a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -365,7 +365,7 @@ sub create_interface { return Sys::Virt::Interface->_new(connection =3D> $self, xml =3D> $xml= ); } =20 -=3Ditem my $dom =3D $vmm->define_interface($xml); +=3Ditem my $dom =3D $conn->define_interface($xml); =20 Defines, but does not start, a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -383,7 +383,7 @@ sub define_interface { return Sys::Virt::Interface->_new(connection =3D> $self, xml =3D> $xml= , nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $vmm->create_node_device($xml); +=3Ditem my $dom =3D $conn->create_node_device($xml); =20 Create a new virtual node device based on the XML description passed into = the C<$xml> parameter. The returned object is an instance of the L @@ -400,7 +400,7 @@ sub create_node_device { } =20 =20 -=3Ditem my @doms =3D $vmm->list_domains() +=3Ditem my @doms =3D $conn->list_domains() =20 Return a list of all running domains currently known to the VMM. The eleme= nts in the returned list are instances of the L class. This @@ -426,17 +426,17 @@ sub list_domains { return @domains; } =20 -=3Ditem my $nids =3D $vmm->num_of_domains() +=3Ditem my $nids =3D $conn->num_of_domains() =20 Return the number of running domains known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @domIDs =3D $vmm->list_domain_ids($maxids) +=3Ditem my @domIDs =3D $conn->list_domain_ids($maxids) =20 Return a list of all domain IDs currently known to the VMM. The IDs can be used with the C method. =20 -=3Ditem my @doms =3D $vmm->list_defined_domains() +=3Ditem my @doms =3D $conn->list_defined_domains() =20 Return a list of all domains defined, but not currently running, on the VMM. The elements in the returned list are instances of the @@ -463,24 +463,24 @@ sub list_defined_domains { return @domains; } =20 -=3Ditem my $nnames =3D $vmm->num_of_defined_domains() +=3Ditem my $nnames =3D $conn->num_of_defined_domains() =20 Return the number of running domains known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @names =3D $vmm->list_defined_domain_names($maxnames) +=3Ditem my @names =3D $conn->list_defined_domain_names($maxnames) =20 Return a list of names of all domains defined, but not currently running, = on the VMM. The names can be used with the C method. =20 -=3Ditem my @doms =3D $vmm->list_all_domains($flags) +=3Ditem my @doms =3D $conn->list_all_domains($flags) =20 Return a list of all domains currently known to the VMM, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned domains. =20 -=3Ditem my @nets =3D $vmm->list_networks() +=3Ditem my @nets =3D $conn->list_networks() =20 Return a list of all networks currently known to the VMM. The elements in the returned list are instances of the L class. @@ -507,17 +507,17 @@ sub list_networks { return @networks; } =20 -=3Ditem my $nnames =3D $vmm->num_of_networks() +=3Ditem my $nnames =3D $conn->num_of_networks() =20 Return the number of running networks known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @netNames =3D $vmm->list_network_names($maxnames) +=3Ditem my @netNames =3D $conn->list_network_names($maxnames) =20 Return a list of all network names currently known to the VMM. The names c= an be used with the C method. =20 -=3Ditem my @nets =3D $vmm->list_defined_networks() +=3Ditem my @nets =3D $conn->list_defined_networks() =20 Return a list of all networks defined, but not currently running, on the VMM. The elements in the returned list are instances of the @@ -544,24 +544,24 @@ sub list_defined_networks { return @networks; } =20 -=3Ditem my $nnamess =3D $vmm->num_of_defined_networks() +=3Ditem my $nnamess =3D $conn->num_of_defined_networks() =20 Return the number of running networks known to the host. This can be used as the C parameter to C. =20 -=3Ditem my @names =3D $vmm->list_defined_network_names($maxnames) +=3Ditem my @names =3D $conn->list_defined_network_names($maxnames) =20 Return a list of names of all networks defined, but not currently running,= on the host. The names can be used with the C method. =20 -=3Ditem my @nets =3D $vmm->list_all_networks($flags) +=3Ditem my @nets =3D $conn->list_all_networks($flags) =20 Return a list of all networks currently known to the VMM, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned networks. =20 -=3Ditem my @pools =3D $vmm->list_storage_pools() +=3Ditem my @pools =3D $conn->list_storage_pools() =20 Return a list of all storage pools currently known to the host. The elemen= ts in the returned list are instances of the L class. @@ -588,17 +588,17 @@ sub list_storage_pools { return @pools; } =20 -=3Ditem my $nnames =3D $vmm->num_of_storage_pools() +=3Ditem my $nnames =3D $conn->num_of_storage_pools() =20 Return the number of running storage pools known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @poolNames =3D $vmm->list_storage_pool_names($maxnames) +=3Ditem my @poolNames =3D $conn->list_storage_pool_names($maxnames) =20 Return a list of all storage pool names currently known to the VMM. The ID= s can be used with the C method. =20 -=3Ditem my @pools =3D $vmm->list_defined_storage_pools() +=3Ditem my @pools =3D $conn->list_defined_storage_pools() =20 Return a list of all storage pools defined, but not currently running, on = the host. The elements in the returned list are instances of the @@ -625,24 +625,24 @@ sub list_defined_storage_pools { return @pools; } =20 -=3Ditem my $nnames =3D $vmm->num_of_defined_storage_pools() +=3Ditem my $nnames =3D $conn->num_of_defined_storage_pools() =20 Return the number of running networks known to the host. This can be used as the C parameter to C. =20 -=3Ditem my @names =3D $vmm->list_defined_storage_pool_names($maxnames) +=3Ditem my @names =3D $conn->list_defined_storage_pool_names($maxnames) =20 Return a list of names of all storage pools defined, but not currently run= ning, on the host. The names can be used with the C metho= d. =20 -=3Ditem my @pools =3D $vmm->list_all_storage_pools($flags) +=3Ditem my @pools =3D $conn->list_all_storage_pools($flags) =20 Return a list of all storage pools currently known to the VMM, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned pools. =20 -=3Ditem my @devs =3D $vmm->list_node_devices($capability) +=3Ditem my @devs =3D $conn->list_node_devices($capability) =20 Return a list of all devices currently known to the host OS. The elements in the returned list are instances of the L class. @@ -672,7 +672,7 @@ sub list_node_devices { return @devs; } =20 -=3Ditem my $nnames =3D $vmm->num_of_node_devices($capability[, $flags]) +=3Ditem my $nnames =3D $conn->num_of_node_devices($capability[, $flags]) =20 Return the number of host devices known to the VMM. This can be used as the C parameter to C. @@ -681,7 +681,7 @@ only devices with a particular capability type, and sho= uld be left as C if the full list is required. The optional parameter is currently unused and defaults to 0 if omitted. =20 -=3Ditem my @netNames =3D $vmm->list_node_device_names($capability, $maxnam= es[, $flags]) +=3Ditem my @netNames =3D $conn->list_node_device_names($capability, $maxna= mes[, $flags]) =20 Return a list of all host device names currently known to the VMM. The nam= es can be used with the C method. @@ -690,14 +690,14 @@ only devices with a particular capability type, and s= hould be left as C if the full list is required. The optional parameter is currently unused and defaults to 0 if omitted. =20 -=3Ditem my @devs =3D $vmm->list_all_node_devices($flags) +=3Ditem my @devs =3D $conn->list_all_node_devices($flags) =20 Return a list of all node devices currently known to the VMM. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned devices. =20 -=3Ditem my @ifaces =3D $vmm->list_interfaces() +=3Ditem my @ifaces =3D $conn->list_interfaces() =20 Return a list of all network interfaces currently known to the VMM. The el= ements in the returned list are instances of the L class. @@ -724,17 +724,17 @@ sub list_interfaces { return @interfaces; } =20 -=3Ditem my $nnames =3D $vmm->num_of_interfaces() +=3Ditem my $nnames =3D $conn->num_of_interfaces() =20 Return the number of running interfaces known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @names =3D $vmm->list_interface_names($maxnames) +=3Ditem my @names =3D $conn->list_interface_names($maxnames) =20 Return a list of all interface names currently known to the VMM. The names= can be used with the C method. =20 -=3Ditem my @ifaces =3D $vmm->list_defined_interfaces() +=3Ditem my @ifaces =3D $conn->list_defined_interfaces() =20 Return a list of all network interfaces currently known to the VMM. The el= ements in the returned list are instances of the L class. @@ -761,24 +761,24 @@ sub list_defined_interfaces { return @interfaces; } =20 -=3Ditem my $nnames =3D $vmm->num_of_defined_interfaces() +=3Ditem my $nnames =3D $conn->num_of_defined_interfaces() =20 Return the number of inactive interfaces known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @names =3D $vmm->list_defined_interface_names($maxnames) +=3Ditem my @names =3D $conn->list_defined_interface_names($maxnames) =20 Return a list of inactive interface names currently known to the VMM. The = names can be used with the C method. =20 -=3Ditem my @ifaces =3D $vmm->list_all_interfaces($flags) +=3Ditem my @ifaces =3D $conn->list_all_interfaces($flags) =20 Return a list of all interfaces currently known to the VMM, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned interfaces. =20 -=3Ditem my @ifaces =3D $vmm->list_secrets() +=3Ditem my @ifaces =3D $conn->list_secrets() =20 Return a list of all secrets currently known to the VMM. The elements in the returned list are instances of the L class. @@ -805,24 +805,24 @@ sub list_secrets { return @secrets; } =20 -=3Ditem my $nuuids =3D $vmm->num_of_secrets() +=3Ditem my $nuuids =3D $conn->num_of_secrets() =20 Return the number of secrets known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @uuids =3D $vmm->list_secret_uuids($maxuuids) +=3Ditem my @uuids =3D $conn->list_secret_uuids($maxuuids) =20 Return a list of all secret uuids currently known to the VMM. The uuids can be used with the C method. =20 -=3Ditem my @secrets =3D $vmm->list_all_secrets($flags) +=3Ditem my @secrets =3D $conn->list_all_secrets($flags) =20 Return a list of all secrets currently known to the VMM. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned secrets. =20 -=3Ditem my @nets =3D $vmm->list_nwfilters() +=3Ditem my @nets =3D $conn->list_nwfilters() =20 Return a list of all nwfilters currently known to the VMM. The elements in the returned list are instances of the L class. @@ -849,36 +849,36 @@ sub list_nwfilters { return @nwfilters; } =20 -=3Ditem my $nnames =3D $vmm->num_of_nwfilters() +=3Ditem my $nnames =3D $conn->num_of_nwfilters() =20 Return the number of running nwfilters known to the VMM. This can be used as the C parameter to C. =20 -=3Ditem my @filterNames =3D $vmm->list_nwfilter_names($maxnames) +=3Ditem my @filterNames =3D $conn->list_nwfilter_names($maxnames) =20 Return a list of all nwfilter names currently known to the VMM. The names = can be used with the C method. =20 -=3Ditem my @nwfilters =3D $vmm->list_all_nwfilters($flags) +=3Ditem my @nwfilters =3D $conn->list_all_nwfilters($flags) =20 Return a list of all nwfilters currently known to the VMM. The elements in the returned list are instances of the L class. The C<$flags> parameter is currently unused and defaults to zero. =20 -=3Ditem $vmm->define_save_image_xml($file, $dxml, $flags=3D0) +=3Ditem $conn->define_save_image_xml($file, $dxml, $flags=3D0) =20 Update the XML associated with a virtual machine's save image. The C<$file> parameter is the fully qualified path to the save image XML, while C<$dxml> is the new XML document to write. The C<$flags> parameter is currently unused and defaults to zero. =20 -=3Ditem $xml =3D $vmm->get_save_image_xml_description($file, $flags=3D1) +=3Ditem $xml =3D $conn->get_save_image_xml_description($file, $flags=3D1) =20 Retrieve the current XML configuration associated with the virtual machine's save image identified by C<$file>. The C<$flags> parameter is cu= rrently unused and defaults to zero. =20 -=3Ditem my $dom =3D $vmm->get_domain_by_name($name) +=3Ditem my $dom =3D $conn->get_domain_by_name($name) =20 Return the domain with a name of C<$name>. The returned object is an instance of the L class. @@ -894,7 +894,7 @@ sub get_domain_by_name { =20 =20 =20 -=3Ditem my $dom =3D $vmm->get_domain_by_id($id) +=3Ditem my $dom =3D $conn->get_domain_by_id($id) =20 Return the domain with a local id of C<$id>. The returned object is an instance of the L class. @@ -910,7 +910,7 @@ sub get_domain_by_id { =20 =20 =20 -=3Ditem my $dom =3D $vmm->get_domain_by_uuid($uuid) +=3Ditem my $dom =3D $conn->get_domain_by_uuid($uuid) =20 Return the domain with a globally unique id of C<$uuid>. The returned obje= ct is an instance of the L class. @@ -924,7 +924,7 @@ sub get_domain_by_uuid { return Sys::Virt::Domain->_new(connection =3D> $self, uuid =3D> $uuid); } =20 -=3Ditem my $net =3D $vmm->get_network_by_name($name) +=3Ditem my $net =3D $conn->get_network_by_name($name) =20 Return the network with a name of C<$name>. The returned object is an instance of the L class. @@ -939,7 +939,7 @@ sub get_network_by_name { } =20 =20 -=3Ditem my $net =3D $vmm->get_network_by_uuid($uuid) +=3Ditem my $net =3D $conn->get_network_by_uuid($uuid) =20 Return the network with a globally unique id of C<$uuid>. The returned obj= ect is an instance of the L class. @@ -953,7 +953,7 @@ sub get_network_by_uuid { return Sys::Virt::Network->_new(connection =3D> $self, uuid =3D> $uuid= ); } =20 -=3Ditem my $pool =3D $vmm->get_storage_pool_by_name($name) +=3Ditem my $pool =3D $conn->get_storage_pool_by_name($name) =20 Return the storage pool with a name of C<$name>. The returned object is an instance of the L class. @@ -968,7 +968,7 @@ sub get_storage_pool_by_name { } =20 =20 -=3Ditem my $pool =3D $vmm->get_storage_pool_by_uuid($uuid) +=3Ditem my $pool =3D $conn->get_storage_pool_by_uuid($uuid) =20 Return the storage pool with a globally unique id of C<$uuid>. The returne= d object is an instance of the L class. @@ -983,7 +983,7 @@ sub get_storage_pool_by_uuid { } =20 =20 -=3Ditem my $pool =3D $vmm->get_storage_pool_by_volume($vol) +=3Ditem my $pool =3D $conn->get_storage_pool_by_volume($vol) =20 Return the storage pool with a storage volume C<$vol>. The C<$vol> paramet= er must be an instance of the L class. The returned ob= ject is @@ -999,7 +999,7 @@ sub get_storage_pool_by_volume { } =20 =20 -=3Ditem my $pool =3D $vmm->get_storage_pool_by_target_path($path) +=3Ditem my $pool =3D $conn->get_storage_pool_by_target_path($path) =20 Return the storage pool with a target path of C<$path>. The returned objec= t is an instance of the L class. @@ -1014,7 +1014,7 @@ sub get_storage_pool_by_target_path { } =20 =20 -=3Ditem my $vol =3D $vmm->get_storage_volume_by_path($path) +=3Ditem my $vol =3D $conn->get_storage_volume_by_path($path) =20 Return the storage volume with a location of C<$path>. The returned object= is an instance of the L class. @@ -1029,7 +1029,7 @@ sub get_storage_volume_by_path { } =20 =20 -=3Ditem my $vol =3D $vmm->get_storage_volume_by_key($key) +=3Ditem my $vol =3D $conn->get_storage_volume_by_key($key) =20 Return the storage volume with a globally unique id of C<$key>. The return= ed object is an instance of the L class. @@ -1043,7 +1043,7 @@ sub get_storage_volume_by_key { return Sys::Virt::StorageVol->_new(connection =3D> $self, key =3D> $ke= y); } =20 -=3Ditem my $dev =3D $vmm->get_node_device_by_name($name) +=3Ditem my $dev =3D $conn->get_node_device_by_name($name) =20 Return the node device with a name of C<$name>. The returned object is an instance of the L class. @@ -1058,7 +1058,7 @@ sub get_node_device_by_name { } =20 =20 -=3Ditem my $dev =3D $vmm->get_node_device_scsihost_by_wwn($wwnn, $wwpn, $f= lags=3D0) +=3Ditem my $dev =3D $conn->get_node_device_scsihost_by_wwn($wwnn, $wwpn, $= flags=3D0) =20 Return the node device which is a SCSI host identified by C<$wwnn> and C<$= wwpn>. The C<$flags> parameter is unused and defaults to zero. The returned obje= ct is @@ -1077,7 +1077,7 @@ sub get_node_device_scsihost_by_wwn { } =20 =20 -=3Ditem my $iface =3D $vmm->get_interface_by_name($name) +=3Ditem my $iface =3D $conn->get_interface_by_name($name) =20 Return the interface with a name of C<$name>. The returned object is an instance of the L class. @@ -1092,7 +1092,7 @@ sub get_interface_by_name { } =20 =20 -=3Ditem my $iface =3D $vmm->get_interface_by_mac($mac) +=3Ditem my $iface =3D $conn->get_interface_by_mac($mac) =20 Return the interface with a MAC address of C<$mac>. The returned object is an instance of the L class. @@ -1107,7 +1107,7 @@ sub get_interface_by_mac { } =20 =20 -=3Ditem my $sec =3D $vmm->get_secret_by_uuid($uuid) +=3Ditem my $sec =3D $conn->get_secret_by_uuid($uuid) =20 Return the secret with a globally unique id of C<$uuid>. The returned obje= ct is an instance of the L class. @@ -1121,7 +1121,7 @@ sub get_secret_by_uuid { return Sys::Virt::Secret->_new(connection =3D> $self, uuid =3D> $uuid); } =20 -=3Ditem my $sec =3D $vmm->get_secret_by_usage($usageType, $usageID) +=3Ditem my $sec =3D $conn->get_secret_by_usage($usageType, $usageID) =20 Return the secret with a usage type of C<$usageType>, identified by C<$usageID>. The returned object is an instance of the @@ -1139,7 +1139,7 @@ sub get_secret_by_usage { usageID =3D> $id); } =20 -=3Ditem my $dom =3D $vmm->get_nwfilter_by_name($name) +=3Ditem my $dom =3D $conn->get_nwfilter_by_name($name) =20 Return the domain with a name of C<$name>. The returned object is an instance of the L class. @@ -1154,7 +1154,7 @@ sub get_nwfilter_by_name { } =20 =20 -=3Ditem my $dom =3D $vmm->get_nwfilter_by_uuid($uuid) +=3Ditem my $dom =3D $conn->get_nwfilter_by_uuid($uuid) =20 Return the nwfilter with a globally unique id of C<$uuid>. The returned ob= ject is an instance of the L class. @@ -1168,7 +1168,7 @@ sub get_nwfilter_by_uuid { return Sys::Virt::NWFilter->_new(connection =3D> $self, uuid =3D> $uui= d); } =20 -=3Ditem my $xml =3D $vmm->find_storage_pool_sources($type, $srcspec[, $fla= gs]) +=3Ditem my $xml =3D $conn->find_storage_pool_sources($type, $srcspec[, $fl= ags]) =20 Probe for available storage pool sources for the pool of type C<$type>. The C<$srcspec> parameter can be C, or a parameter to refine the @@ -1177,7 +1177,7 @@ C<$flags> parameter is optional, and if omitted defau= lts to zero. The returned scalar is an XML document describing the discovered storage pool sources. =20 -=3Ditem my @stats =3D $vmm->get_all_domain_stats($stats, \@doms=3Dundef, $= flags=3D0); +=3Ditem my @stats =3D $conn->get_all_domain_stats($stats, \@doms=3Dundef, = $flags=3D0); =20 Get a list of all statistics for domains known to the hypervisor. The C<$stats> parameter controls which data fields to return and @@ -1193,67 +1193,67 @@ The element will be a hash with two keys, C po= inting to an instance of C and C pointing to another hash reference containing the actual statistics. =20 -=3Ditem $vmm->interface_change_begin($flags) +=3Ditem $conn->interface_change_begin($flags) =20 Begin a transaction for changing the configuration of one or more network interfaces =20 -=3Ditem $vmm->interface_change_commit($flags) +=3Ditem $conn->interface_change_commit($flags) =20 Complete a transaction for changing the configuration of one or more network interfaces =20 -=3Ditem $vmm->interface_change_rollback($flags) +=3Ditem $conn->interface_change_rollback($flags) =20 Abort a transaction for changing the configuration of one or more network interfaces =20 -=3Ditem $vmm->restore_domain($savefile) +=3Ditem $conn->restore_domain($savefile) =20 Recreate a domain from the saved state file given in the C<$savefile> para= meter. =20 -=3Ditem $vmm->get_max_vcpus($domtype) +=3Ditem $conn->get_max_vcpus($domtype) =20 Return the maximum number of vcpus that can be configured for a domain of type C<$domtype> =20 -=3Ditem my $hostname =3D $vmm->get_hostname() +=3Ditem my $hostname =3D $conn->get_hostname() =20 Return the name of the host with which this connection is associated. =20 -=3Ditem my $uri =3D $vmm->get_uri() +=3Ditem my $uri =3D $conn->get_uri() =20 Return the URI associated with the open connection. This may be different from the URI used when initially connecting to libvirt, when 'auto-probing' or drivers occurrs. =20 -=3Ditem my $xml =3D $vmm->get_sysinfo() +=3Ditem my $xml =3D $conn->get_sysinfo() =20 Return an XML documenting representing the host system information, typically obtained from SMBIOS tables. =20 -=3Ditem my $type =3D $vmm->get_type() +=3Ditem my $type =3D $conn->get_type() =20 Return the type of virtualization backend accessed by this VMM object. Cur= rently the only supported type is C. =20 -=3Ditem my $xml =3D $vmm->domain_xml_from_native($format, $config); +=3Ditem my $xml =3D $conn->domain_xml_from_native($format, $config); =20 Convert the native hypervisor configuration C<$config> which is in format <$format> into libvirrt domain XML. Valid values of C<$format> vary between hypervisor drivers. =20 -=3Ditem my $config =3D $vmm->domain_xml_to_native($format, $xml) +=3Ditem my $config =3D $conn->domain_xml_to_native($format, $xml) =20 Convert the libvirt domain XML configuration C<$xml> to a native hypervisor configuration in format C<$format> =20 -=3Ditem my $ver =3D $vmm->get_version() +=3Ditem my $ver =3D $conn->get_version() =20 Return the complete version number as a string encoded in the formula C<(major * 1000000) + (minor * 1000) + micro>. =20 -=3Ditem my $ver =3D $vmm->get_major_version +=3Ditem my $ver =3D $conn->get_major_version =20 Return the major version number of the libvirt library. =20 @@ -1266,7 +1266,7 @@ sub get_major_version { } =20 =20 -=3Ditem my $ver =3D $vmm->get_minor_version +=3Ditem my $ver =3D $conn->get_minor_version =20 Return the minor version number of the libvirt library. =20 @@ -1279,7 +1279,7 @@ sub get_minor_version { return ($mver - ($mver % 1000)) / 1000; } =20 -=3Ditem my $ver =3D $vmm->get_micro_version +=3Ditem my $ver =3D $conn->get_micro_version =20 Return the micro version number of the libvirt library. =20 @@ -1299,7 +1299,7 @@ sub get_version { } } =20 -=3Ditem my $ver =3D $vmm->get_library_version +=3Ditem my $ver =3D $conn->get_library_version =20 Return the version number of the API associated with the active connection. This differs from C --=20 2.14.3 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sat Apr 20 02:47:07 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 152036121347083.96317739474091; Tue, 6 Mar 2018 10:33:33 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 498804DD49; Tue, 6 Mar 2018 18:33:32 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2515760BEC; Tue, 6 Mar 2018 18:33:32 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id D9C8718033F0; Tue, 6 Mar 2018 18:33:31 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w26IXArs008968 for ; Tue, 6 Mar 2018 13:33:10 -0500 Received: by smtp.corp.redhat.com (Postfix) id AD0241C71C; Tue, 6 Mar 2018 18:33:10 +0000 (UTC) Received: from vhost2.laine.org (ovpn-116-195.phx2.redhat.com [10.3.116.195]) by smtp.corp.redhat.com (Postfix) with ESMTP id 445901C720 for ; Tue, 6 Mar 2018 18:33:10 +0000 (UTC) From: Laine Stump To: libvir-list@redhat.com Date: Tue, 6 Mar 2018 13:33:01 -0500 Message-Id: <20180306183302.522518-3-laine@laine.org> In-Reply-To: <20180306183302.522518-1-laine@laine.org> References: <20180306183302.522518-1-laine@laine.org> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-loop: libvir-list@redhat.com Subject: [libvirt] [perl PATCH 2/3] docs: replace VMM with hypervisor X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Tue, 06 Mar 2018 18:33:32 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" I *think* this makes the most sense in the context of the descriptions, but am open to other ideas (I also considered "virtualization host", which might be better; it just seemed a bit long...) Signed-off-by: Laine Stump Reviewed-by: Daniel P. Berrang=C3=A9 --- lib/Sys/Virt.pm | 92 ++++++++++++++++++++++++++++-------------------------= ---- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/lib/Sys/Virt.pm b/lib/Sys/Virt.pm index 6a643fa..13b2603 100644 --- a/lib/Sys/Virt.pm +++ b/lib/Sys/Virt.pm @@ -119,8 +119,8 @@ Xen driver on C using TCP / SASL security For further details consult C =20 If the optional C parameter is supplied, then an unprivileged -connection to the VMM will be attempted. If it is not supplied, then it -defaults to making a fully privileged connection to the VMM. If the +connection to the hypervisor will be attempted. If it is not supplied, the= n it +defaults to making a fully privileged connection to the hypervisor. If the calling application is not running as root, it may be necessary to provide authentication callbacks. =20 @@ -226,7 +226,7 @@ sub new_stream { Create a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. The C<$flags> parameter accepts one of the DOMAIN CREATION +the hypervisor. The C<$flags> parameter accepts one of the DOMAIN CREATION constants documented in L, and defaults to 0 if omitted. =20 =3Dcut @@ -244,7 +244,7 @@ sub create_domain { Create a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. The C<$fds> parameter is an array of UNIX file descriptors +the hypervisor. The C<$fds> parameter is an array of UNIX file descriptors which will be passed to the init process of the container. This is only supported with container based virtualization. The C<$flags> parameter accepts one of the DOMAIN CREATION constants documented @@ -267,7 +267,7 @@ sub create_domain_with_files { Defines, but does not start, a new domain based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with -unprivileged connections to the VMM. The defined domain can be later start= ed +unprivileged connections to the hypervisor. The defined domain can be late= r started by calling the C method on the returned C object. =20 @@ -286,7 +286,7 @@ sub define_domain { Create a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. +the hypervisor. =20 =3Dcut =20 @@ -302,7 +302,7 @@ sub create_network { Defines, but does not start, a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with -unprivileged connections to the VMM. The defined network can be later star= ted +unprivileged connections to the hypervisor. The defined network can be lat= er started by calling the C method on the returned C object. =20 @@ -320,7 +320,7 @@ sub define_network { Create a new storage pool based on the XML description passed into the C<$= xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. +the hypervisor. =20 =3Dcut =20 @@ -336,7 +336,7 @@ sub create_storage_pool { Defines, but does not start, a new storage pol based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with -unprivileged connections to the VMM. The defined pool can be later started +unprivileged connections to the hypervisor. The defined pool can be later = started by calling the C method on the returned C object. =20 @@ -354,7 +354,7 @@ sub define_storage_pool { Create a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. +the hypervisor. =20 =3Dcut =20 @@ -370,7 +370,7 @@ sub create_interface { Defines, but does not start, a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with -unprivileged connections to the VMM. The defined interface can be later st= arted +unprivileged connections to the hypervisor. The defined interface can be l= ater started by calling the C method on the returned C object. =20 @@ -388,7 +388,7 @@ sub define_interface { Create a new virtual node device based on the XML description passed into = the C<$xml> parameter. The returned object is an instance of the L class. This method is not available with unprivileged connections to -the VMM. +the hypervisor. =20 =3Dcut =20 @@ -402,7 +402,7 @@ sub create_node_device { =20 =3Ditem my @doms =3D $conn->list_domains() =20 -Return a list of all running domains currently known to the VMM. The eleme= nts +Return a list of all running domains currently known to the hypervisor. Th= e elements in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. @@ -428,18 +428,18 @@ sub list_domains { =20 =3Ditem my $nids =3D $conn->num_of_domains() =20 -Return the number of running domains known to the VMM. This can be +Return the number of running domains known to the hypervisor. This can be used as the C parameter to C. =20 =3Ditem my @domIDs =3D $conn->list_domain_ids($maxids) =20 -Return a list of all domain IDs currently known to the VMM. The IDs can +Return a list of all domain IDs currently known to the hypervisor. The IDs= can be used with the C method. =20 =3Ditem my @doms =3D $conn->list_defined_domains() =20 Return a list of all domains defined, but not currently running, on the -VMM. The elements in the returned list are instances of the +hypervisor. The elements in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. =20 @@ -465,24 +465,24 @@ sub list_defined_domains { =20 =3Ditem my $nnames =3D $conn->num_of_defined_domains() =20 -Return the number of running domains known to the VMM. This can be +Return the number of running domains known to the hypervisor. This can be used as the C parameter to C. =20 =3Ditem my @names =3D $conn->list_defined_domain_names($maxnames) =20 Return a list of names of all domains defined, but not currently running, = on -the VMM. The names can be used with the C method. +the hypervisor. The names can be used with the C metho= d. =20 =3Ditem my @doms =3D $conn->list_all_domains($flags) =20 -Return a list of all domains currently known to the VMM, whether +Return a list of all domains currently known to the hypervisor, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned domains. =20 =3Ditem my @nets =3D $conn->list_networks() =20 -Return a list of all networks currently known to the VMM. The elements +Return a list of all networks currently known to the hypervisor. The eleme= nts in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. @@ -509,18 +509,18 @@ sub list_networks { =20 =3Ditem my $nnames =3D $conn->num_of_networks() =20 -Return the number of running networks known to the VMM. This can be +Return the number of running networks known to the hypervisor. This can be used as the C parameter to C. =20 =3Ditem my @netNames =3D $conn->list_network_names($maxnames) =20 -Return a list of all network names currently known to the VMM. The names c= an +Return a list of all network names currently known to the hypervisor. The = names can be used with the C method. =20 =3Ditem my @nets =3D $conn->list_defined_networks() =20 Return a list of all networks defined, but not currently running, on the -VMM. The elements in the returned list are instances of the +hypervisor. The elements in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. =20 @@ -556,7 +556,7 @@ the host. The names can be used with the C method. =20 =3Ditem my @nets =3D $conn->list_all_networks($flags) =20 -Return a list of all networks currently known to the VMM, whether +Return a list of all networks currently known to the hypervisor, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned networks. @@ -590,12 +590,12 @@ sub list_storage_pools { =20 =3Ditem my $nnames =3D $conn->num_of_storage_pools() =20 -Return the number of running storage pools known to the VMM. This can be +Return the number of running storage pools known to the hypervisor. This c= an be used as the C parameter to C. =20 =3Ditem my @poolNames =3D $conn->list_storage_pool_names($maxnames) =20 -Return a list of all storage pool names currently known to the VMM. The ID= s can +Return a list of all storage pool names currently known to the hypervisor.= The IDs can be used with the C method. =20 =3Ditem my @pools =3D $conn->list_defined_storage_pools() @@ -637,7 +637,7 @@ the host. The names can be used with the C method. =20 =3Ditem my @pools =3D $conn->list_all_storage_pools($flags) =20 -Return a list of all storage pools currently known to the VMM, whether +Return a list of all storage pools currently known to the hypervisor, whet= her running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned pools. @@ -674,7 +674,7 @@ sub list_node_devices { =20 =3Ditem my $nnames =3D $conn->num_of_node_devices($capability[, $flags]) =20 -Return the number of host devices known to the VMM. This can be +Return the number of host devices known to the hypervisor. This can be used as the C parameter to C. The C parameter allows the list to be restricted to only devices with a particular capability type, and should be left @@ -683,7 +683,7 @@ parameter is currently unused and defaults to 0 if omit= ted. =20 =3Ditem my @netNames =3D $conn->list_node_device_names($capability, $maxna= mes[, $flags]) =20 -Return a list of all host device names currently known to the VMM. The nam= es can +Return a list of all host device names currently known to the hypervisor. = The names can be used with the C method. The C parameter allows the list to be restricted to only devices with a particular capability type, and should be left @@ -692,14 +692,14 @@ parameter is currently unused and defaults to 0 if om= itted. =20 =3Ditem my @devs =3D $conn->list_all_node_devices($flags) =20 -Return a list of all node devices currently known to the VMM. The +Return a list of all node devices currently known to the hypervisor. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned devices. =20 =3Ditem my @ifaces =3D $conn->list_interfaces() =20 -Return a list of all network interfaces currently known to the VMM. The el= ements +Return a list of all network interfaces currently known to the hypervisor.= The elements in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method = is recommended as a more efficient alternative. @@ -726,17 +726,17 @@ sub list_interfaces { =20 =3Ditem my $nnames =3D $conn->num_of_interfaces() =20 -Return the number of running interfaces known to the VMM. This can be +Return the number of running interfaces known to the hypervisor. This can = be used as the C parameter to C. =20 =3Ditem my @names =3D $conn->list_interface_names($maxnames) =20 -Return a list of all interface names currently known to the VMM. The names= can +Return a list of all interface names currently known to the hypervisor. Th= e names can be used with the C method. =20 =3Ditem my @ifaces =3D $conn->list_defined_interfaces() =20 -Return a list of all network interfaces currently known to the VMM. The el= ements +Return a list of all network interfaces currently known to the hypervisor.= The elements in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method = is recommended as a more efficient alternative. @@ -763,24 +763,24 @@ sub list_defined_interfaces { =20 =3Ditem my $nnames =3D $conn->num_of_defined_interfaces() =20 -Return the number of inactive interfaces known to the VMM. This can be +Return the number of inactive interfaces known to the hypervisor. This can= be used as the C parameter to C. =20 =3Ditem my @names =3D $conn->list_defined_interface_names($maxnames) =20 -Return a list of inactive interface names currently known to the VMM. The = names can +Return a list of inactive interface names currently known to the hyperviso= r. The names can be used with the C method. =20 =3Ditem my @ifaces =3D $conn->list_all_interfaces($flags) =20 -Return a list of all interfaces currently known to the VMM, whether +Return a list of all interfaces currently known to the hypervisor, whether running or shutoff. The elements in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned interfaces. =20 =3Ditem my @ifaces =3D $conn->list_secrets() =20 -Return a list of all secrets currently known to the VMM. The elements +Return a list of all secrets currently known to the hypervisor. The elemen= ts in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. @@ -807,24 +807,24 @@ sub list_secrets { =20 =3Ditem my $nuuids =3D $conn->num_of_secrets() =20 -Return the number of secrets known to the VMM. This can be +Return the number of secrets known to the hypervisor. This can be used as the C parameter to C. =20 =3Ditem my @uuids =3D $conn->list_secret_uuids($maxuuids) =20 -Return a list of all secret uuids currently known to the VMM. The uuids can +Return a list of all secret uuids currently known to the hypervisor. The u= uids can be used with the C method. =20 =3Ditem my @secrets =3D $conn->list_all_secrets($flags) =20 -Return a list of all secrets currently known to the VMM. The elements +Return a list of all secrets currently known to the hypervisor. The elemen= ts in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned secrets. =20 =3Ditem my @nets =3D $conn->list_nwfilters() =20 -Return a list of all nwfilters currently known to the VMM. The elements +Return a list of all nwfilters currently known to the hypervisor. The elem= ents in the returned list are instances of the L class. This method requires O(n) RPC calls, so the C method is recommended as a more efficient alternative. @@ -851,17 +851,17 @@ sub list_nwfilters { =20 =3Ditem my $nnames =3D $conn->num_of_nwfilters() =20 -Return the number of running nwfilters known to the VMM. This can be +Return the number of running nwfilters known to the hypervisor. This can be used as the C parameter to C. =20 =3Ditem my @filterNames =3D $conn->list_nwfilter_names($maxnames) =20 -Return a list of all nwfilter names currently known to the VMM. The names = can +Return a list of all nwfilter names currently known to the hypervisor. The= names can be used with the C method. =20 =3Ditem my @nwfilters =3D $conn->list_all_nwfilters($flags) =20 -Return a list of all nwfilters currently known to the VMM. The elements +Return a list of all nwfilters currently known to the hypervisor. The elem= ents in the returned list are instances of the L class. The C<$flags> parameter is currently unused and defaults to zero. =20 @@ -1234,7 +1234,7 @@ typically obtained from SMBIOS tables. =20 =3Ditem my $type =3D $conn->get_type() =20 -Return the type of virtualization backend accessed by this VMM object. Cur= rently +Return the type of virtualization backend accessed by this hypervisor obje= ct. Currently the only supported type is C. =20 =3Ditem my $xml =3D $conn->domain_xml_from_native($format, $config); --=20 2.14.3 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sat Apr 20 02:47:07 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1520361214082691.7183854614952; Tue, 6 Mar 2018 10:33:34 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id CE26A28216; Tue, 6 Mar 2018 18:33:31 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2D44A18026; Tue, 6 Mar 2018 18:33:31 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id E73424A470; Tue, 6 Mar 2018 18:33:30 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w26IXB9G008979 for ; Tue, 6 Mar 2018 13:33:11 -0500 Received: by smtp.corp.redhat.com (Postfix) id 648401C71C; Tue, 6 Mar 2018 18:33:11 +0000 (UTC) Received: from vhost2.laine.org (ovpn-116-195.phx2.redhat.com [10.3.116.195]) by smtp.corp.redhat.com (Postfix) with ESMTP id F05D31C71F for ; Tue, 6 Mar 2018 18:33:10 +0000 (UTC) From: Laine Stump To: libvir-list@redhat.com Date: Tue, 6 Mar 2018 13:33:02 -0500 Message-Id: <20180306183302.522518-4-laine@laine.org> In-Reply-To: <20180306183302.522518-1-laine@laine.org> References: <20180306183302.522518-1-laine@laine.org> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-loop: libvir-list@redhat.com Subject: [libvirt] [perl PATCH 3/3] docs: fix other assorted example variable names X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Tue, 06 Mar 2018 18:33:32 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" There were quite a few instances of apparent copy/paste from domain examples over to examples of the same action on a different type of object (e.g. calling define_network() and assigning the result to a variable called $dom). This patch removes as many of them as I noticed while doing a search for "=3D item ". Hopefully this makes the examples less confusing. Signed-off-by: Laine Stump Reviewed-by: Daniel P. Berrang=C3=A9 --- lib/Sys/Virt.pm | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/lib/Sys/Virt.pm b/lib/Sys/Virt.pm index 13b2603..4726f9a 100644 --- a/lib/Sys/Virt.pm +++ b/lib/Sys/Virt.pm @@ -281,7 +281,7 @@ sub define_domain { return Sys::Virt::Domain->_new(connection =3D> $self, xml =3D> $xml, n= ocreate =3D> 1, flags =3D> $flags); } =20 -=3Ditem my $dom =3D $conn->create_network($xml); +=3Ditem my $net =3D $conn->create_network($xml); =20 Create a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -297,7 +297,7 @@ sub create_network { return Sys::Virt::Network->_new(connection =3D> $self, xml =3D> $xml); } =20 -=3Ditem my $dom =3D $conn->define_network($xml); +=3Ditem my $net =3D $conn->define_network($xml); =20 Defines, but does not start, a new network based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -315,7 +315,7 @@ sub define_network { return Sys::Virt::Network->_new(connection =3D> $self, xml =3D> $xml, = nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $conn->create_storage_pool($xml); +=3Ditem my $pool =3D $conn->create_storage_pool($xml); =20 Create a new storage pool based on the XML description passed into the C<$= xml> parameter. The returned object is an instance of the L @@ -331,7 +331,7 @@ sub create_storage_pool { return Sys::Virt::StoragePool->_new(connection =3D> $self, xml =3D> $x= ml); } =20 -=3Ditem my $dom =3D $conn->define_storage_pool($xml); +=3Ditem my $pool =3D $conn->define_storage_pool($xml); =20 Defines, but does not start, a new storage pol based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -349,7 +349,7 @@ sub define_storage_pool { return Sys::Virt::StoragePool->_new(connection =3D> $self, xml =3D> $x= ml, nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $conn->create_interface($xml); +=3Ditem my $pool =3D $conn->create_interface($xml); =20 Create a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance of the L @@ -365,7 +365,7 @@ sub create_interface { return Sys::Virt::Interface->_new(connection =3D> $self, xml =3D> $xml= ); } =20 -=3Ditem my $dom =3D $conn->define_interface($xml); +=3Ditem my $iface =3D $conn->define_interface($xml); =20 Defines, but does not start, a new interface based on the XML description passed into the C<$xml> parameter. The returned object is an instance @@ -383,7 +383,7 @@ sub define_interface { return Sys::Virt::Interface->_new(connection =3D> $self, xml =3D> $xml= , nocreate =3D> 1); } =20 -=3Ditem my $dom =3D $conn->create_node_device($xml); +=3Ditem my $dev =3D $conn->create_node_device($xml); =20 Create a new virtual node device based on the XML description passed into = the C<$xml> parameter. The returned object is an instance of the L @@ -463,7 +463,7 @@ sub list_defined_domains { return @domains; } =20 -=3Ditem my $nnames =3D $conn->num_of_defined_domains() +=3Ditem my $ndoms =3D $conn->num_of_defined_domains() =20 Return the number of running domains known to the hypervisor. This can be used as the C parameter to C. @@ -507,7 +507,7 @@ sub list_networks { return @networks; } =20 -=3Ditem my $nnames =3D $conn->num_of_networks() +=3Ditem my $nnets =3D $conn->num_of_networks() =20 Return the number of running networks known to the hypervisor. This can be used as the C parameter to C. @@ -544,7 +544,7 @@ sub list_defined_networks { return @networks; } =20 -=3Ditem my $nnamess =3D $conn->num_of_defined_networks() +=3Ditem my $nnets =3D $conn->num_of_defined_networks() =20 Return the number of running networks known to the host. This can be used as the C parameter to C. @@ -588,7 +588,7 @@ sub list_storage_pools { return @pools; } =20 -=3Ditem my $nnames =3D $conn->num_of_storage_pools() +=3Ditem my $npools =3D $conn->num_of_storage_pools() =20 Return the number of running storage pools known to the hypervisor. This c= an be used as the C parameter to C. @@ -625,7 +625,7 @@ sub list_defined_storage_pools { return @pools; } =20 -=3Ditem my $nnames =3D $conn->num_of_defined_storage_pools() +=3Ditem my $npools =3D $conn->num_of_defined_storage_pools() =20 Return the number of running networks known to the host. This can be used as the C parameter to C. @@ -672,7 +672,7 @@ sub list_node_devices { return @devs; } =20 -=3Ditem my $nnames =3D $conn->num_of_node_devices($capability[, $flags]) +=3Ditem my $ndevs =3D $conn->num_of_node_devices($capability[, $flags]) =20 Return the number of host devices known to the hypervisor. This can be used as the C parameter to C. @@ -681,7 +681,7 @@ only devices with a particular capability type, and sho= uld be left as C if the full list is required. The optional parameter is currently unused and defaults to 0 if omitted. =20 -=3Ditem my @netNames =3D $conn->list_node_device_names($capability, $maxna= mes[, $flags]) +=3Ditem my @devNames =3D $conn->list_node_device_names($capability, $maxna= mes[, $flags]) =20 Return a list of all host device names currently known to the hypervisor. = The names can be used with the C method. @@ -724,7 +724,7 @@ sub list_interfaces { return @interfaces; } =20 -=3Ditem my $nnames =3D $conn->num_of_interfaces() +=3Ditem my $nifaces =3D $conn->num_of_interfaces() =20 Return the number of running interfaces known to the hypervisor. This can = be used as the C parameter to C. @@ -761,7 +761,7 @@ sub list_defined_interfaces { return @interfaces; } =20 -=3Ditem my $nnames =3D $conn->num_of_defined_interfaces() +=3Ditem my $nifaces =3D $conn->num_of_defined_interfaces() =20 Return the number of inactive interfaces known to the hypervisor. This can= be used as the C parameter to C. @@ -822,7 +822,7 @@ in the returned list are instances of the L class. The C<$flags> parameter can be used to filter the list of returned secrets. =20 -=3Ditem my @nets =3D $conn->list_nwfilters() +=3Ditem my @nwfilters =3D $conn->list_nwfilters() =20 Return a list of all nwfilters currently known to the hypervisor. The elem= ents in the returned list are instances of the L class. @@ -849,7 +849,7 @@ sub list_nwfilters { return @nwfilters; } =20 -=3Ditem my $nnames =3D $conn->num_of_nwfilters() +=3Ditem my $nnwfilters =3D $conn->num_of_nwfilters() =20 Return the number of running nwfilters known to the hypervisor. This can be used as the C parameter to C. @@ -1139,7 +1139,7 @@ sub get_secret_by_usage { usageID =3D> $id); } =20 -=3Ditem my $dom =3D $conn->get_nwfilter_by_name($name) +=3Ditem my $nwfilter =3D $conn->get_nwfilter_by_name($name) =20 Return the domain with a name of C<$name>. The returned object is an instance of the L class. @@ -1154,7 +1154,7 @@ sub get_nwfilter_by_name { } =20 =20 -=3Ditem my $dom =3D $conn->get_nwfilter_by_uuid($uuid) +=3Ditem my $nwfilter =3D $conn->get_nwfilter_by_uuid($uuid) =20 Return the nwfilter with a globally unique id of C<$uuid>. The returned ob= ject is an instance of the L class. --=20 2.14.3 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list