Module Odig.Conf

module Conf: sig .. end
Odig configuration.


type t 
The type for odig configuration.
val default_file : Fpath.t
default_file is the default configuration file.
val v : ?trust_cache:bool ->
cachedir:Fpath.t -> libdir:Fpath.t -> docdir:Fpath.t -> unit -> t
v ~trust_cache ~cachedir ~libdir ~docdir () is a configuration using cachedir as the odig cache directory, libdir for looking up package compilation objects and docdir for looking up package documentation. If trust_cache is true (defaults to false) indicates the data of cachedir should be trusted regardless of whether libdir and docdir may have changed.
val of_file : ?trust_cache:bool ->
Fpath.t -> (t, Bos_setup.R.msg) Bos_setup.result
of_file f reads a configuration from configuration file f. See Odig.Conf.v.
val of_opam_switch : ?trust_cache:bool ->
?switch:string -> unit -> (t, Bos_setup.R.msg) Bos_setup.result
of_opam_switch ~switch () is a configuration for the opam switch switch (defaults to the current switch). See Odig.Conf.v.
val libdir : t -> Fpath.t
libdir c is c's package library directory.
val docdir : t -> Fpath.t
docdir c is c's package documentation directory.


val cachedir : t -> Fpath.t
cachedir c is c's odig cache directory.
val trust_cache : t -> bool
trust_cache c indicates if c is trusting odig's cache.
val clear_cache : t -> (unit, Bos_setup.R.msg) Bos_setup.result
clear_cache c deletes c's cache directory.

Package cache

val pkg_cachedir : t -> Fpath.t
pkg_cachedir c is c's cache directory for packages it is located inside Odig.Conf.cachedir.
val cached_pkgs_names : t -> (Bos_setup.String.set, Bos_setup.R.msg) Bos_setup.result
cached_pkgs_names c is the set of names of the packages that are cached in c. Note that these packages may not correspond or be up-to-date with packages found in the configuration.