[libvirt] [PATCH] [libvirt-perl] Add missing $flags arguments to documentation

[Daniel P. Berrange]

On Wed, Oct 12, 2011 at 09:48:39PM +0200, Guido Günther wrote:
> Hi,
> when looking at the DomainSnapshot docs I wondered if these also take
> the flags argument as the other functions so I went ahead and updated
> the docs after checking the source.
> Cheers,
>  -- Guido
> 
> ---
>  lib/Sys/Virt/DomainSnapshot.pm |   16 ++++++++++------
>  1 files changed, 10 insertions(+), 6 deletions(-)
> 
> diff --git a/lib/Sys/Virt/DomainSnapshot.pm b/lib/Sys/Virt/DomainSnapshot.pm
> index 1c4a008..5b7204b 100644
> --- a/lib/Sys/Virt/DomainSnapshot.pm
> +++ b/lib/Sys/Virt/DomainSnapshot.pm
> @@ -60,18 +60,22 @@ sub _new {
>      return $self;
>  }
>  
> -=item my $xml = $dom->get_xml_description()
> +=item my $xml = $dom->get_xml_description($flags)
>  
>  Returns an XML document containing a complete description of
> -the domain's configuration
> +the domain's configuration.
>  
> -=item $dom->delete()
> +=item $dom->delete($flags)
>  
> -Deletes this snapshot object & its datra
> +Deletes this snapshot object & its data. The optional C<$flags> parameter controls
> +what should be deleted via the C<Sys::Virt::DomainSnapshot::DELETE_*>
> +constants.
>  
> -=item $dom->revert_to()
> +=item $dom->revert_to($flags)
>  
> -Revert the domain to the state associated with this snapshot
> +Revert the domain to the state associated with this snapshot. The optional
> +C<$flags> control the state of the vm after the revert via the
> +C<Sys::Virt::DomainSnapshot::REVERT_*> constants.
>  
>  =back
>  

ACK


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|