Skip to content

Split odoc_driver into 3 sub-commands #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 8, 2024
Merged

Split odoc_driver into 3 sub-commands #1237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c57974
Split odoc_driver into 3 sub-commands
gpetiot Nov 7, 2024
a1a6e82
Update src/driver/odoc_driver.ml
gpetiot Nov 8, 2024
1f44852
Arg 'blessed' is only used in voodoo mode
gpetiot Nov 8, 2024
bbb67d7
Arg 'packages' is only used in opam mode
gpetiot Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions src/driver/common_args.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
open Cmdliner

let fpath_arg =
let print ppf v = Fpath.pp ppf v in
Arg.conv (Fpath.of_string, print)

let odoc_dir =
let doc = "Directory in which the intermediate odoc files go" in
Arg.(value & opt fpath_arg (Fpath.v "_odoc/") & info [ "odoc-dir" ] ~doc)

let odocl_dir =
let doc = "Directory in which the intermediate odocl files go" in
Arg.(value & opt (some fpath_arg) None & info [ "odocl-dir" ] ~doc)

let index_dir =
let doc = "Directory in which the index files go" in
Arg.(value & opt fpath_arg (Fpath.v "_indexes/") & info [ "index-dir" ] ~doc)

let mld_dir =
let doc = "Directory in which the auto-generated mld files go" in
Arg.(value & opt fpath_arg (Fpath.v "_mlds/") & info [ "mld-dir" ] ~doc)

let html_dir =
let doc = "Directory in which the generated HTML files go" in
Arg.(value & opt fpath_arg (Fpath.v "_html/") & info [ "html-dir" ] ~doc)

let verbose =
let doc = "Enable verbose output" in
Arg.(value & flag & info [ "v"; "verbose" ] ~doc)

let stats =
let doc = "Produce 'driver-benchmarks.json' with run stats" in
Arg.(value & flag & info [ "stats" ] ~doc)

let nb_workers =
let doc = "Number of workers." in
Arg.(value & opt int 15 & info [ "j" ] ~doc)

let odoc_bin =
let doc = "Odoc binary to use" in
Arg.(value & opt (some string) None & info [ "odoc" ] ~doc)

let compile_grep =
let doc = "Show compile commands containing the string" in
Arg.(value & opt (some string) None & info [ "compile-grep" ] ~doc)

let link_grep =
let doc = "Show link commands containing the string" in
Arg.(value & opt (some string) None & info [ "link-grep" ] ~doc)

let generate_grep =
let doc = "Show html-generate commands containing the string" in
Arg.(value & opt (some string) None & info [ "html-grep" ] ~doc)

type t = {
verbose : bool;
odoc_dir : Fpath.t;
odocl_dir : Fpath.t option;
index_dir : Fpath.t;
mld_dir : Fpath.t;
html_dir : Fpath.t;
stats : bool;
nb_workers : int;
odoc_bin : string option;
compile_grep : string option;
link_grep : string option;
generate_grep : string option;
}

let term =
let open Term in
let ( let+ ) t f = const f $ t in
let ( and+ ) a b = const (fun x y -> (x, y)) $ a $ b in
let+ verbose = verbose
and+ odoc_dir = odoc_dir
and+ odocl_dir = odocl_dir
and+ index_dir = index_dir
and+ mld_dir = mld_dir
and+ html_dir = html_dir
and+ stats = stats
and+ nb_workers = nb_workers
and+ odoc_bin = odoc_bin
and+ compile_grep = compile_grep
and+ link_grep = link_grep
and+ generate_grep = generate_grep in
{
verbose;
odoc_dir;
odocl_dir;
index_dir;
mld_dir;
html_dir;
stats;
nb_workers;
odoc_bin;
compile_grep;
link_grep;
generate_grep;
}
178 changes: 80 additions & 98 deletions src/driver/odoc_driver.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,9 +551,26 @@ let remap_virtual_interfaces duplicate_hashes pkgs =
})
pkgs

let run libs verbose packages_dir odoc_dir odocl_dir index_dir mld_dir html_dir
stats nb_workers odoc_bin voodoo package_name blessed dune_style
compile_grep link_grep generate_grep =
type mode =
| Voodoo of { package_name : string; blessed : bool }
| Dune of { path : Fpath.t }
| Opam of { packages : string list; packages_dir : Fpath.t option }
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonludlam this is where the new argument libs will go in #1229


let run mode
{
Common_args.verbose;
odoc_dir;
odocl_dir;
index_dir;
mld_dir;
html_dir;
stats;
nb_workers;
odoc_bin;
compile_grep;
link_grep;
generate_grep;
} =
Option.iter (fun odoc_bin -> Odoc.odoc := Bos.Cmd.v odoc_bin) odoc_bin;
let _ = Voodoo.find_universe_and_version "foo" in
Eio_main.run @@ fun env ->
Expand All @@ -564,26 +581,19 @@ let run libs verbose packages_dir odoc_dir odocl_dir index_dir mld_dir html_dir
let () = Worker_pool.start_workers env sw nb_workers in

let all, extra_libs_paths =
match (voodoo, package_name, dune_style, packages_dir) with
| true, Some p, None, None ->
match mode with
| Voodoo { package_name = p; blessed } ->
let all = Voodoo.of_voodoo p ~blessed in
let extra_libs_paths = Voodoo.extra_libs_paths odoc_dir in
(all, extra_libs_paths)
| false, None, Some dir, None ->
(Dune_style.of_dune_build dir, Util.StringMap.empty)
| false, None, None, packages_dir ->
let libs = if libs = [] then Ocamlfind.all () else libs in
| Dune { path } -> (Dune_style.of_dune_build path, Util.StringMap.empty)
| Opam { packages; packages_dir } ->
let libs = if packages = [] then Ocamlfind.all () else packages in
let libs =
List.map Ocamlfind.sub_libraries libs
|> List.fold_left Util.StringSet.union Util.StringSet.empty
in
(Packages.of_libs ~packages_dir libs, Util.StringMap.empty)
| true, None, _, _ -> failwith "--voodoo requires --package"
| false, Some _, _, _ -> failwith "--package requires --voodoo"
| true, _, _, Some _ | false, _, Some _, Some _ ->
failwith "--packages-dir is only useful in opam mode"
| true, _, Some _, _ ->
failwith "--voodoo and --dune-style are mutually exclusive"
in

let virtual_check =
Expand Down Expand Up @@ -611,13 +621,14 @@ let run libs verbose packages_dir odoc_dir odocl_dir index_dir mld_dir html_dir
let all = remap_virtual_interfaces virtual_check all in

let partial =
if voodoo then
match Util.StringMap.to_list all with
| [ (_, p) ] ->
let output_path = Fpath.(odoc_dir // p.pkg_dir) in
Some output_path
| _ -> failwith "Error, expecting singleton library in voodoo mode"
else None
match mode with
| Voodoo _ -> (
match Util.StringMap.to_list all with
| [ (_, p) ] ->
let output_path = Fpath.(odoc_dir // p.pkg_dir) in
Some output_path
| _ -> failwith "Error, expecting singleton library in voodoo mode")
| _ -> None
in
let () =
Eio.Fiber.both
Expand Down Expand Up @@ -661,92 +672,63 @@ let run libs verbose packages_dir odoc_dir odocl_dir index_dir mld_dir html_dir
Format.eprintf "Total time: %f@.%!" (Stats.total_time ());
if stats then Stats.bench_results html_dir

let fpath_arg =
let print ppf v = Fpath.pp ppf v in
Arg.conv (Fpath.of_string, print)
module Voodoo_mode = struct
let run package_name blessed = run (Voodoo { package_name; blessed })

let odoc_dir =
let doc = "Directory in which the intermediate odoc files go" in
Arg.(value & opt fpath_arg (Fpath.v "_odoc/") & info [ "odoc-dir" ] ~doc)
let package_name =
let doc = "Name of package to process with voodoo" in
Arg.(value & pos 0 string "" & info [] ~doc)

let odocl_dir =
let doc = "Directory in which the intermediate odocl files go" in
Arg.(value & opt (some fpath_arg) None & info [ "odocl-dir" ] ~doc)
let blessed =
let doc = "Blessed" in
Arg.(value & flag & info [ "blessed" ] ~doc)

let index_dir =
let doc = "Directory in which the index files go" in
Arg.(value & opt fpath_arg (Fpath.v "_indexes/") & info [ "index-dir" ] ~doc)
let cmd =
let doc = "Process output from voodoo-prep" in
let info = Cmd.info "voodoo" ~doc in
Cmd.v info Term.(const run $ package_name $ blessed $ Common_args.term)
end

let mld_dir =
let doc = "Directory in which the auto-generated mld files go" in
Arg.(value & opt fpath_arg (Fpath.v "_mlds/") & info [ "mld-dir" ] ~doc)
module Dune_mode = struct
let run path = run (Dune { path })

let html_dir =
let doc = "Directory in which the generated HTML files go" in
Arg.(value & opt fpath_arg (Fpath.v "_html/") & info [ "html-dir" ] ~doc)
let dune_style =
Arg.(value & pos 0 Common_args.fpath_arg (Fpath.v ".") & info [])

let packages =
(* TODO: Is it package or library? *)
let doc = "The packages to document" in
Arg.(value & opt_all string [] & info [ "p" ] ~doc)

let verbose =
let doc = "Enable verbose output" in
Arg.(value & flag & info [ "v"; "verbose" ] ~doc)

let stats =
let doc = "Produce 'driver-benchmarks.json' with run stats" in
Arg.(value & flag & info [ "stats" ] ~doc)

let nb_workers =
let doc = "Number of workers." in
Arg.(value & opt int 15 & info [ "j" ] ~doc)

let odoc_bin =
let doc = "Odoc binary to use" in
Arg.(value & opt (some string) None & info [ "odoc" ] ~doc)

let packages_dir =
let doc = "Packages directory under which packages should be output." in
Arg.(value & opt (some fpath_arg) None & info [ "packages-dir" ] ~doc)

let voodoo =
let doc = "Process output from voodoo-prep" in
Arg.(value & flag & info [ "voodoo" ] ~doc)

let package_name =
let doc = "Name of package to process with voodoo" in
Arg.(value & opt (some string) None & info [ "package" ] ~doc)

let blessed =
let doc = "Blessed" in
Arg.(value & flag & info [ "blessed" ] ~doc)

let dune_style =
let doc = "Dune style" in
Arg.(value & opt (some fpath_arg) None & info [ "dune-style" ] ~doc)

let compile_grep =
let doc = "Show compile commands containing the string" in
Arg.(value & opt (some string) None & info [ "compile-grep" ] ~doc)

let link_grep =
let doc = "Show link commands containing the string" in
Arg.(value & opt (some string) None & info [ "link-grep" ] ~doc)

let generate_grep =
let doc = "Show html-generate commands containing the string" in
Arg.(value & opt (some string) None & info [ "html-grep" ] ~doc)
let cmd =
let doc =
"Dune mode, which builds the documentation of the local libraries of a \
dune project."
in
let info = Cmd.info "dune" ~doc in
Cmd.v info Term.(const run $ dune_style $ Common_args.term)
end

module Opam_mode = struct
let run packages packages_dir = run (Opam { packages; packages_dir })

let packages =
(* TODO: Is it package or library? *)
let doc = "The packages to document" in
Arg.(value & opt_all string [] & info [ "p" ] ~doc)

let packages_dir =
let doc = "Packages directory under which packages should be output." in
Arg.(
value
& opt (some Common_args.fpath_arg) None
& info [ "packages-dir" ] ~doc)

let cmd =
let doc = "Opam mode" in
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This manpage string can be made more explicit in #1229.

let info = Cmd.info "opam" ~doc in
Cmd.v info Term.(const run $ packages $ packages_dir $ Common_args.term)
end

let cmd =
let doc = "Generate odoc documentation" in
let info = Cmd.info "odoc_driver" ~doc in
Cmd.v info
Term.(
const run $ packages $ verbose $ packages_dir $ odoc_dir $ odocl_dir
$ index_dir $ mld_dir $ html_dir $ stats $ nb_workers $ odoc_bin $ voodoo
$ package_name $ blessed $ dune_style $ compile_grep $ link_grep
$ generate_grep)
Cmd.group info [ Voodoo_mode.cmd; Dune_mode.cmd; Opam_mode.cmd ]

(* let map = Ocamlfind.package_to_dir_map () in
let _dirs = List.map (fun lib -> List.assoc lib map) deps in
Expand Down
Loading