Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Configuration options for the state lib (record, global reference, setter, initialisation)
module E : sig ... end
type t = private {
root_dir : OpamFilename.Dir.t;
current_switch : OpamSwitch.t option;
switch_from : OpamStateTypes.provenance;
jobs : int Stdlib.Lazy.t;
dl_jobs : int;
build_test : bool;
build_doc : bool;
dryrun : bool;
makecmd : string Stdlib.Lazy.t;
ignore_constraints_on : OpamTypes.name_set;
unlock_base : bool;
no_env_notice : bool;
locked : string option;
no_depexts : bool;
}
type 'a options_fun =
?root_dir:OpamFilename.Dir.t ->
?current_switch:OpamSwitch.t ->
?switch_from:OpamStateTypes.provenance ->
?jobs:int Stdlib.Lazy.t ->
?dl_jobs:int ->
?build_test:bool ->
?build_doc:bool ->
?dryrun:bool ->
?makecmd:string Stdlib.Lazy.t ->
?ignore_constraints_on:OpamTypes.name_set ->
?unlock_base:bool ->
?no_env_notice:bool ->
?locked:string option ->
?no_depexts:bool ->
'a
include OpamStd.Config.Sig
with type t := t
and type 'a options_fun := 'a options_fun
val default : t
val set : t -> (unit -> t) options_fun
val setk : (t -> 'a) -> t -> 'a options_fun
val r : t Stdlib.ref
val update : ?noop:'a -> (unit -> unit) options_fun
val init : ?noop:'a -> (unit -> unit) options_fun
val initk : 'a -> 'a options_fun
val opamroot : ?root_dir:OpamTypes.dirname -> unit -> OpamTypes.dirname
Get the initial opam root value (from default, env or optional argument). This allows one to get it before doing the init, which is useful to get the configuration file used to fill some options to init()
val load :
?lock_kind:'a OpamStateTypes.lock ->
OpamTypes.dirname ->
OpamFile.Config.t option
Loads the global configuration file, protecting against concurrent writes
val safe_load :
?lock_kind:'a OpamStateTypes.lock ->
OpamTypes.dirname ->
OpamFile.Config.t
val load_defaults :
?lock_kind:'a OpamStateTypes.lock ->
OpamFilename.Dir.t ->
OpamFile.Config.t option
Loads the config file from the OPAM root and updates default values for all related OpamXxxConfig modules. Doesn't read the env yet, the init
functions should still be called afterwards. OpamFormat should be initialised beforehand, as it may impact the config file loading.
Returns the config file that was found, if any
val get_switch : unit -> OpamTypes.switch
Returns the current switch, failing with an error message is none is set.
val get_switch_opt : unit -> OpamTypes.switch option
Returns the current switch, if any is set.
val get_current_switch_from_cwd : OpamFilename.Dir.t -> OpamTypes.switch option
The function used to locate an external switch from parents of the current directory. Takes the opam root as parameter, and rejects any external switch configured with a different root
val local_switch_exists : OpamFilename.Dir.t -> OpamTypes.switch -> bool
Checks if a local switch exists and is configurade for the given root
val resolve_local_switch :
OpamFilename.Dir.t ->
OpamTypes.switch ->
OpamTypes.switch
Resolves the switch if it is a link to a global switch in the given root (return unchanged otherwise)
val is_newer_than_self :
?lock_kind:'a OpamStateTypes.lock ->
'b OpamStateTypes.global_state ->
bool
Given the required lock, returns true
if the opam root is newer than the binary, so that it can only be loaded read-only by the current binary.
val is_newer : OpamFile.Config.t -> bool
Check config root version regarding self-defined one
val load_config_root :
?lock_kind:'a OpamStateTypes.lock ->
((OpamFile.Config.t OpamFile.t -> 'b) * (OpamFile.Config.t OpamFile.t -> 'b)) ->
OpamTypes.dirname ->
'b
module Switch : sig ... end
module Repos : sig ... end