Driver: improve compile mli

Signed-off-by: Paul-Elliot <[email protected]>

Author: panglesd

src/driver/compile.ml

@@ -104,7 +104,7 @@ let find_partials odoc_dir =
   | Ok h -> (h, tbl)
   | Error _ -> (* odoc_dir doesn't exist...? *) (Util.StringMap.empty, tbl)
 
-let compile partial ~output_dir ?linked_dir all =
+let compile ?partial ~output_dir ?linked_dir all =
   let linked_dir = Option.value linked_dir ~default:output_dir in
   let hashes = mk_byhash all in
   let other_hashes, tbl =

src/driver/compile.mli

@@ -3,11 +3,16 @@ type compiled
 val init_stats : Packages.set -> unit
 
 val compile :
-  Fpath.t option ->
+  ?partial:Fpath.t ->
   output_dir:Fpath.t ->
   ?linked_dir:Fpath.t ->
   Packages.set ->
   compiled list
+(** Use [partial] to reuse the output of a previous call to [compile]. Useful in
+    the voodoo context.
+
+    [output_dir] is the directory for [odoc] file, [linked_dir] is the one for
+    [odocl] files (defaulting to [output_dir] when absent). *)
 
 type linked
 

src/driver/odoc_driver.ml

@@ -537,7 +537,8 @@ let run libs verbose packages_dir odoc_dir odocl_dir html_dir stats nb_workers
     Eio.Fiber.both
       (fun () ->
         let compiled =
-          Compile.compile partial ~output_dir:odoc_dir ?linked_dir:odocl_dir all
+          Compile.compile ?partial ~output_dir:odoc_dir ?linked_dir:odocl_dir
+            all
         in
         let linked = Compile.link compiled in
         let odocl_dir = match odocl_dir with Some l -> l | None -> odoc_dir in