X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=libvirt%2Flibvirt.mli;h=ec945b74774055613dc5befea9951e15ff2022f7;hb=2d54c385902ef411f9329d72bc26910d768937d6;hp=89c6d9047c2ca6904a755920db70dd277632c244;hpb=6de624657b83a1792cf21393cb71f61a446a9c52;p=ocaml-libvirt.git

diff --git a/libvirt/libvirt.mli b/libvirt/libvirt.mli
index 89c6d90..ec945b7 100644
--- a/libvirt/libvirt.mli
+++ b/libvirt/libvirt.mli
@@ -440,6 +440,11 @@ sig
     tx_drop : int64;
   }
 
+  val max_peek : [>`R] t -> int
+    (** Maximum size supported by the {!block_peek} and {!memory_peek}
+	functions.  If you want to peek more than this then you must
+	break your request into chunks. *)
+
   val create_linux : [>`W] Connect.t -> xml -> rw t
     (** Create a new guest domain (not necessarily a Linux one)
 	from the given XML.
@@ -567,14 +572,18 @@ sig
 	[offset] in the domain's [path] block device.
 
 	If successful then the data is written into [buf] starting
-	at offset [boff], for [size] bytes. *)
+	at offset [boff], for [size] bytes.
+
+	See also {!max_peek}. *)
   val memory_peek : [>`R] t -> memory_flag list -> int64 -> int ->
     string -> int -> unit
     (** [memory_peek dom Virtual offset size] reads [size] bytes
 	at [offset] in the domain's virtual memory.
 
 	If successful then the data is written into [buf] starting
-	at offset [boff], for [size] bytes. *)
+	at offset [boff], for [size] bytes.
+
+	See also {!max_peek}. *)
 
   external const : [>`R] t -> ro t = "%identity"
     (** [const dom] turns a read/write domain handle into a read-only