Merge pull request #34 from avsm/master

v0.7.1

CHANGES

@@ -1,5 +1,7 @@
-0.7.1 (trunk):
+0.7.1 (2014-12-05):
 * Do not emit debug output when the `CONDUIT_DEBUG` variable is not set.
+* Do not create symlinks in a local build, which helps with OPAM pins.
+* Improve ocamldoc for `Conduit_lwt_unix`.
 
 0.7.0 (2014-12-04):
 * Add Lwt-unix support for the native OCaml/TLS stack as an alternative

build.sh

@@ -139,7 +139,7 @@ fi
 
 REQS=`echo $PKG $ASYNC_REQUIRES $LWT_REQUIRES $LWT_UNIX_REQUIRES $LWT_MIRAGE_REQUIRES $LWT_MIRAGE_XEN_REQUIRES $VCHAN_LWT_REQUIRES | tr -s ' '`
 
-ocamlbuild -use-ocamlfind -j ${J_FLAG} -tag ${TAGS} \
+ocamlbuild -use-ocamlfind -no-links -j ${J_FLAG} -tag ${TAGS} \
   -cflags "-w A-4-33-40-41-42-43-34-44" \
   -pkgs `echo $REQS | tr ' ' ','` \
   ${TARGETS}

lib/conduit_lwt_unix.mli

@@ -21,6 +21,8 @@
 
 open Sexplib.Conv
 
+(** {2 Core types} *)
+
 (** Configuration fragment for a TLS client connecting to a remote endpoint *)
 type client_tls_config =
   [ `Hostname of string ] *
@@ -62,22 +64,26 @@ type 'a io = 'a Lwt.t
 type ic = Lwt_io.input_channel
 type oc = Lwt_io.output_channel
 
+(** [tcp_flow] contains the state of a single TCP connection. *)
 type tcp_flow = private {
   fd: Lwt_unix.file_descr sexp_opaque;
   ip: Ipaddr.t;
   port: int;
 } with sexp_of
 
+(** [domain_flow] contains the state of a single Unix domain socket connection. *)
 type domain_flow = private {
   fd: Lwt_unix.file_descr sexp_opaque;
   path: string;
 } with sexp_of
 
+(** [vchan_flow] contains the state of a single Vchan shared memory connection. *)
 type vchan_flow = private {
   domid: int;
   port: string;
 } with sexp_of
 
+(** A [flow] contains the state of a single connection, over a specific transport method. *)
 type flow = private
   | TCP of tcp_flow
   | Domain_socket of domain_flow
@@ -96,6 +102,8 @@ type tls_server_key = [
 (** State handler for an active conduit *)
 type ctx with sexp_of
 
+(** {2 Connection and listening} *)
+
 (** Default context that listens on all source addresses with
     no TLS certificate associated with the Conduit *)
 val default_ctx : ctx