Driver: improved interface for the Packages module

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

Author: panglesd

src/driver/packages.ml

@@ -72,7 +72,7 @@ let pkg_dir top_dir pkg_name = maybe_prepend_top top_dir Fpath.(v pkg_name)
 
 let parent_of_lib pkg_dir lib_name = Fpath.(pkg_dir / "lib" / lib_name)
 
-let parent_of_pkg pkg_dir = Fpath.(pkg_dir / "doc")
+let parent_of_pages pkg_dir = Fpath.(pkg_dir / "doc")
 
 let parent_of_src pkg_dir lib_name = Fpath.(pkg_dir / "src" / lib_name)
 
@@ -336,7 +336,7 @@ let of_libs ~packages_dir libs =
         | None -> acc
         | Some rel_path ->
             let pkg_dir = pkg_dir packages_dir pkg_name in
-            let id = Fpath.(parent_of_pkg pkg_dir // rel_path) in
+            let id = Fpath.(parent_of_pages pkg_dir // rel_path) in
             let mld_parent_id = id |> Fpath.parent |> Fpath.rem_empty_seg in
             let page_name = Fpath.(rem_ext mld_path |> filename) in
             let odoc_file =
@@ -404,7 +404,7 @@ let of_libs ~packages_dir libs =
                       mlds = update_mlds pkg.mlds libraries;
                     }
               | None ->
-                  let mld_odoc_dir = parent_of_pkg pkg_dir in
+                  let mld_odoc_dir = parent_of_pages pkg_dir in
                   Some
                     {
                       name = pkg.name;

src/driver/packages.mli

@@ -67,7 +67,8 @@ type libty = {
   modules : modulety list;
 }
 
-val parent_of_pkg : Fpath.t -> Fpath.t
+val parent_of_pages : Fpath.t -> Fpath.t
+(** Given a [pkg_dir], returns a [mld_odoc_dir]. *)
 
 module Lib : sig
   val v :

src/driver/voodoo.ml

@@ -71,7 +71,7 @@ let process_package pkg =
               | None -> None
               | Some rel_path ->
                   let id =
-                    Fpath.(Packages.parent_of_pkg (top_dir pkg) // rel_path)
+                    Fpath.(Packages.parent_of_pages (top_dir pkg) // rel_path)
                   in
                   let mld_parent_id =
                     id |> Fpath.parent |> Fpath.rem_empty_seg
@@ -168,7 +168,7 @@ let process_package pkg =
       libdirs_without_meta
   in
   Printf.eprintf "Found %d metas" (List.length metas);
-  let mld_odoc_dir = Packages.parent_of_pkg (top_dir pkg) in
+  let mld_odoc_dir = Packages.parent_of_pages (top_dir pkg) in
   let libraries = List.flatten libraries in
   let libraries = List.flatten extra_libraries @ libraries in
   {