From eb66dafe2e30cb92c2350f57d2a87748e8ce60c9 Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Sun, 29 Jul 2018 10:33:01 +0100
Subject: [PATCH] v2v: Add more detailed documentation for input methods.

Just comment changes.
---
 v2v/types.mli | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/v2v/types.mli b/v2v/types.mli
index eeb56d460..6f7a0b5d2 100644
--- a/v2v/types.mli
+++ b/v2v/types.mli
@@ -363,7 +363,36 @@ type output_allocation = Sparse | Preallocated
 
 (** {2 Input object}
 
-    This is subclassed for the various input [-i] options. *)
+    This is subclassed for the various input [-i] options.
+
+    The order of steps is:
+
+{v
+    command line parsing      Input object of right subclass is
+        │                     created depending on ‘-i’ option.
+        │
+        ▼
+    input#precheck            Called very early on, do pre-checks here.
+        │
+        │
+        ▼
+    input#source              Open the source hypervisor connection,
+        │                     read metadata, and fill out and return
+        │                     the ‘Types.source’ structure.
+        ▼
+    conversion                Guest is converted into a local overlay.
+        │
+        │
+        ▼
+    input#adjust_overlay_parameters   Optional method for adjusting
+        │                     QEMU overlay parameters ready for copying
+        │                     (eg. using a larger readahead setting).
+        ▼
+    copying                   Guest data is copied to the target disks
+                              by running ‘qemu-img convert’.
+v}
+
+*)
 
 class virtual input : object
   method precheck : unit -> unit