WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-api

[Xen-API] [PATCH] Minor ocamldoc fix.

To: xen-api <xen-api@xxxxxxxxxxxxxxxxxxx>
Subject: [Xen-API] [PATCH] Minor ocamldoc fix.
From: Rob Hoes <rob.hoes@xxxxxxxxxx>
Date: Tue, 22 Dec 2009 11:57:31 +0000
Delivery-date: Tue, 22 Dec 2009 03:57:33 -0800
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
List-help: <mailto:xen-api-request@lists.xensource.com?subject=help>
List-id: Discussion of API issues surrounding Xen <xen-api.lists.xensource.com>
List-post: <mailto:xen-api@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-api>, <mailto:xen-api-request@lists.xensource.com?subject=unsubscribe>
Sender: xen-api-bounces@xxxxxxxxxxxxxxxxxxx
# HG changeset patch
# User Rob Hoes <rob.hoes@xxxxxxxxxx>
Minor ocamldoc fix.

Signed-off-by: Rob Hoes <rob.hoes@xxxxxxxxxx>

diff -r 7e4670b5a046 stdext/forkhelpers.mli
--- a/stdext/forkhelpers.mli    Tue Dec 22 11:37:00 2009 +0000
+++ b/stdext/forkhelpers.mli    Tue Dec 22 11:55:43 2009 +0000
@@ -32,7 +32,7 @@
     + allows us to offload Unix.fork(), Unix.exec*() to a single-threaded 
separate process
       where the glibc+ocaml runtime codepaths are simpler and hopefully more 
reliable. *)
 
-(** { 1 High-level interface } *)
+(** {2 High-level interface } *)
 
 (** [execute_command_get_output cmd args] runs [cmd args] and returns (stdout, 
stderr)
        on success (exit 0). On failure this raises 
@@ -42,7 +42,7 @@
 (** Thrown by [execute_command_get_output] if the subprocess exits with a 
non-zero exit code *)
 exception Spawn_internal_error of string * string * Unix.process_status
 
-(** { 2 Low-level interface } *)
+(** {2 Low-level interface } *)
 
 (** Represents a forked process *)
 type pidty
@@ -81,12 +81,14 @@
        signal and exits with non-zero code x. *)
 val waitpid_fail_if_bad_exit : pidty -> unit
 
-(** result returned by [with_logfile_fd] *)
-type 'a result = Success of string * 'a | Failure of string * exn
+(** Result returned by {!with_logfile_fd}. *)
+type 'a result =
+| Success of string * 'a       (** The function call completed successfully. *)
+| Failure of string * exn      (** The function raised an exception. *)
 
 (** Creates a temporary file and opens it for logging. The fd is passed to the 
function
-    'f'. The logfile is guaranteed to be closed afterwards, and unlinked if 
either the delete flag is set or the call fails. If the
-    function 'f' throws an error then the log file contents are read in *)
+    [f]. The logfile is guaranteed to be closed afterwards, and unlinked if 
either the delete flag is set or the call fails. If the
+    function [f] throws an error then the log file contents are read in *)
 val with_logfile_fd : ?delete:bool -> string -> (Unix.file_descr -> 'a) -> 'a 
result
 
 

Attachment: forking-docs
Description: Text document

_______________________________________________
xen-api mailing list
xen-api@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/mailman/listinfo/xen-api
<Prev in Thread] Current Thread [Next in Thread>
  • [Xen-API] [PATCH] Minor ocamldoc fix., Rob Hoes <=