[Pkg-libvirt-commits] [libguestfs] 156/266: v2v: Update documentation for input & output classes.

[Hilko Bengen]

This is an automated email from the git hooks/post-receive script.

bengen pushed a commit to annotated tag debian/1%1.27.35-1
in repository libguestfs.

commit 350e3285f35862251165db8233d1d70aac9a73cd
Author: Richard W.M. Jones <rjones at redhat.com>
Date:   Thu Aug 21 21:25:33 2014 +0100

    v2v: Update documentation for input & output classes.
---
 v2v/input_disk.mli     | 3 +++
 v2v/input_libvirt.mli  | 6 ++++++
 v2v/output_RHEV.mli    | 3 +++
 v2v/output_libvirt.mli | 3 +++
 v2v/output_local.mli   | 3 +++
 5 files changed, 18 insertions(+)

diff --git a/v2v/input_disk.mli b/v2v/input_disk.mli
index 3d8d357..df27bcc 100644
--- a/v2v/input_disk.mli
+++ b/v2v/input_disk.mli
@@ -19,3 +19,6 @@
 (** [-i disk] source. *)
 
 val input_disk : bool -> string option -> string -> Types.input
+(** [input_disk verbose input_format disk] creates and returns a new
+    {!Types.input} object specialized for reading input from local
+    disk images. *)
diff --git a/v2v/input_libvirt.mli b/v2v/input_libvirt.mli
index 070ac39..649fdc7 100644
--- a/v2v/input_libvirt.mli
+++ b/v2v/input_libvirt.mli
@@ -19,5 +19,11 @@
 (** [-i libvirt] and [-i libvirtxml] sources. *)
 
 val input_libvirt : bool -> string option -> string -> Types.input
+(** [input_libvirt verbose libvirt_uri guest] creates and returns a
+    new {!Types.input} object specialized for reading input from
+    libvirt sources. *)
 
 val input_libvirtxml : bool -> string -> Types.input
+(** [input_libvirtxml verbose xml_file] creates and returns a new
+    {!Types.input} object specialized for reading input from local
+    libvirt XML files. *)
diff --git a/v2v/output_RHEV.mli b/v2v/output_RHEV.mli
index e043e3a..a916ca9 100644
--- a/v2v/output_RHEV.mli
+++ b/v2v/output_RHEV.mli
@@ -27,3 +27,6 @@ type rhev_params = {
 (** Miscellaneous extra command line parameters used by RHEV. *)
 
 val output_rhev : bool -> string -> rhev_params -> [`Sparse|`Preallocated] -> Types.output
+(** [output_rhev verbose os rhev_params output_alloc] creates and
+    returns a new {!Types.output} object specialized for writing
+    output to RHEV-M or oVirt. *)
diff --git a/v2v/output_libvirt.mli b/v2v/output_libvirt.mli
index 06407f3..d341d5f 100644
--- a/v2v/output_libvirt.mli
+++ b/v2v/output_libvirt.mli
@@ -19,6 +19,9 @@
 (** [-o libvirt] target. *)
 
 val output_libvirt : bool -> string option -> string -> Types.output
+(** [output_libvirt verbose oc output_pool] creates and returns a new
+    {!Types.output} object specialized for writing output to
+    libvirt. *)
 
 val create_libvirt_xml : ?pool:string -> Types.source -> Types.overlay list -> Types.guestcaps -> DOM.doc
 (** This is called from {!Output_local} to generate the libvirt XML. *)
diff --git a/v2v/output_local.mli b/v2v/output_local.mli
index 71e7713..da83359 100644
--- a/v2v/output_local.mli
+++ b/v2v/output_local.mli
@@ -19,3 +19,6 @@
 (** [-o local] target. *)
 
 val output_local : bool -> string -> Types.output
+(** [output_local verbose filename] creates and returns a new
+    {!Types.output} object specialized for writing output to local
+    files. *)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-libvirt/libguestfs.git