jon.recoil.org
this repo has no description
1val find_universe_and_version :
2 string -> (string * string, [> `Msg of string ]) result
3
4type pkg
5
6val find_pkg : string -> blessed:bool -> pkg option
7(** [get_pkg name ~blessed] looks for a package named [name] in the prep
8 directory *)
9
10val of_voodoo : pkg -> Packages.t
11
12val occurrence_file_of_pkg : pkg -> Fpath.t
13(** [occurrences_file_of_pkg pkg odoc_dir] returns an appropriate filename for
14 the occurrences file for [pkg]. *)
15
16type extra_paths = {
17 pkgs : Fpath.t Util.StringMap.t;
18 libs : Fpath.t Util.StringMap.t;
19 libs_of_pkg : string list Util.StringMap.t;
20}
21
22val empty_extra_paths : extra_paths
23(** When [odoc_driver] is not running in voodoo mode, this value can be passed
24 to {!Odoc_units_of.packages} *)
25
26val extra_paths : Fpath.t -> extra_paths
27(** [extra_paths odoc_dir] returns the paths to packages and libraries that have
28 previously been compiled by odoc_driver running in voodoo mode. In order to
29 find these, the previous invocation of odoc_driver will need to have written
30 marker files by calling {!write_lib_markers} *)
31
32val write_lib_markers : Fpath.t -> Packages.t list -> unit
33(** [write_lib_markers odoc_dir pkgs] writes marker files to show the locations
34 of the compilation units associated with packages and libraries in [pkgs].
35*)