Move OCaml client under src so docs build

Also, fix some errors in the doc-strings.

Signed-off-by: Thomas Leonard <[email protected]>

Author: Thomas Leonard

README.md

@@ -373,7 +373,7 @@ status updates for that PR.
 ## Language bindings
 
 * **Go** bindings are in the `api/go` directory.
-* **OCaml** bindings are in the `api/ocaml` directory. See `examples/ocaml-client` for an example.
+* **OCaml** bindings are in the `src/client` directory. See `examples/ocaml-client` for an example.
 
 ## Licensing
 

_oasis

@@ -19,7 +19,7 @@ Library datakit
   Modules:         Datakit
 
 Library client
-  Path:            api/ocaml/lib
+  Path:            src/client
   Findlibparent:   datakit
   Findlibname:     client
   Modules:         Datakit_client_9p, Datakit_path, Datakit_S

api/ocaml/lib/datakit_S.mli renamed to src/client/datakit_S.mli

@@ -1,3 +1,5 @@
+(** DataKit client API *)
+
 open Result
 
 type stat = {
@@ -58,6 +60,7 @@ module type CLIENT = sig
         the current contents of the branch. *)
 
     (** {2 Reading} *)
+
     include READABLE_TREE with type 'a or_error := 'a or_error
 
     (** {2 Writing} *)
@@ -157,7 +160,7 @@ module type CLIENT = sig
       ([`File of Cstruct.t | `Dir of Tree.t | `Link of string | `Exec of Cstruct.t] option ->
        [`Finish of 'a | `Again | `Abort] or_error Lwt.t) ->
       [`Abort | `Finish of 'a] or_error Lwt.t
-    (** [wait_for_path is similar to [wait_for_head], but waits for a particular sub-tree to change. *)
+    (** [wait_for_path] is similar to [wait_for_head], but waits for a particular sub-tree to change. *)
 
     val fast_forward : t -> Commit.t -> unit or_error Lwt.t
     (** [fast_forward t commit] changes [t] to point to [commit] if [t]'s head is an ancestor of [commit]

api/ocaml/lib/datakit_client_9p.ml renamed to src/client/datakit_client_9p.ml

@@ -1,3 +1,5 @@
+(** A DataKit client that connects to the server over a 9p connection. *)
+
 module Make(P9p : Protocol_9p_client.S) : sig
   include Datakit_S.CLIENT with type error = Protocol_9p_error.error
 

api/ocaml/lib/datakit_client_9p.mli renamed to src/client/datakit_client_9p.mli

@@ -1,3 +1,5 @@
+(** Locate files and directories within a DataKit tree. *)
+
 open Result
 
 type t