Updated this file with new <^< operator, should probably delete it.

[virt-df.git] / lib / diskimage.mli

diff --git a/lib/diskimage.mli b/lib/diskimage.mli
index 22ba927..5d2a420 100644 (file)
--- a/lib/diskimage.mli
+++ b/lib/diskimage.mli
@@ -308,12 +308,17 @@ type owner =
     | `Partitions of partitions
     | `PhysicalVolume of pv ]
 
-val get_owners :
-  machine -> ownership -> device -> Int63.t -> (owner * Int63.t) list
-  (** [get_owners machine ownership disk offset] returns the
-      owners (filesystems, etc.) which reside on block device [disk]
-      at the given byte offset.  [disk] must be a block device
-      of the machine.
+val get_owners_lookup : machine -> ownership -> block_device ->
+  (Int63.t -> (owner * Int63.t) list)
+  (** [get_owners_lookup machine disk] returns a specialized
+      function for looking up owners (filesystems, etc.)
+      which reside on block device [disk].
+
+      [disk] must be a block device of the machine.
+
+      The specialized lookup function that is returned
+      can be called as [lookup offset] to look up the
+      owners of byte offset [offset].
 
       Returns a list of [(owner, owner_offset)] where [owner]
       is the filesystem, etc., and [owner_offset] is the byte
@@ -324,8 +329,8 @@ val get_owners :
       both the filesystem ([`Filesystem fs]) and
       partition scheme ([`Partitions parts]) will be returned.
 
-      This function is efficient.  {!create_ownership} creates
-      a tree structure which allows ownership to be determined
+      The specialized function is efficient.  {!create_ownership}
+      creates a tree structure which allows ownership to be determined
       in just a few steps. *)
 
 (** {2 Debugging} *)