From: Richard W.M. Jones <rjones@redhat.com> <"Richard W.M. Jones <rjones@redhat.com>">
Date: Sat, 26 Apr 2008 08:48:58 +0000 (+0100)
Subject: Added some examples.
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=8634421d865fb745cc6ce742f6e43d306a071bac;p=virt-df.git

Added some examples.
---

diff --git a/lib/diskimage.mli b/lib/diskimage.mli
index 113c99b..e3a85b6 100644
--- a/lib/diskimage.mli
+++ b/lib/diskimage.mli
@@ -18,6 +18,17 @@
  *)
 
 (**
+   {2 Examples}
+
+{[
+  let machine = open_machine "host" ["hda", "/dev/hda"] in
+  let machine = scan_machine machine in
+  (* do what you want with the scan results ... *)
+  close_machine machine
+]}
+*)
+
+(**
    {2 Machine/device model}
 
    The "machine/device model" that we currently understand looks