Module `OpamFile.Config`Source

Configuration file: $opam/config

include OpamFile.IO_FILE

Sourcetype t

File contents

Sourceval format_version : OpamVersion.t

Sourceval empty : OpamFile.Config.t

Empty file

Sourceval write : OpamFile.Config.t OpamFile.typed_file -> OpamFile.Config.t -> unit

Write some contents to a file

Sourceval read : OpamFile.Config.t OpamFile.typed_file -> OpamFile.Config.t

Read file contents.

raises OpamSystem.Internal_error
if the file does not exist.

Source

val read_opt : 
  OpamFile.Config.t OpamFile.typed_file ->
  OpamFile.Config.t option

Returns None on non-existing file

Sourceval safe_read : OpamFile.Config.t OpamFile.typed_file -> OpamFile.Config.t

Read file contents. Return empty if the file does not exist.

Source

val read_from_channel : 
  ?filename:OpamFile.Config.t OpamFile.typed_file ->
  Stdlib.in_channel ->
  OpamFile.Config.t

Source

val read_from_string : 
  ?filename:OpamFile.Config.t OpamFile.typed_file ->
  string ->
  OpamFile.Config.t

Source

val write_to_channel : 
  ?filename:OpamFile.Config.t OpamFile.typed_file ->
  Stdlib.out_channel ->
  OpamFile.Config.t ->
  unit

Source

val write_to_string : 
  ?filename:OpamFile.Config.t OpamFile.typed_file ->
  OpamFile.Config.t ->
  string

Sourceval root_version : OpamTypes.opam_version

Current root version

Sourceval with_switch : OpamTypes.switch -> OpamFile.Config.t -> OpamFile.Config.t

OCaml switch updates

Source

val with_switch_opt : 
  OpamTypes.switch option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_installed_switches : 
  OpamTypes.switch list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

The list of switches, ordered by most recently used first

Source

val with_repositories : 
  OpamTypes.repository_name list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Repository updates

Sourceval with_opam_version : OpamVersion.t -> OpamFile.Config.t -> OpamFile.Config.t

Update opam-version

Source

val with_opam_root_version : 
  OpamVersion.t ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_criteria : 
  (OpamTypes.solver_criteria * string) list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_best_effort_prefix : string -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_best_effort_prefix_opt : 
  string option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_solver : OpamTypes.arg list -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_solver_opt : 
  OpamTypes.arg list option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_jobs : int -> OpamFile.Config.t -> OpamFile.Config.t

Sourceval with_jobs_opt : int option -> OpamFile.Config.t -> OpamFile.Config.t

Sourceval with_dl_tool : OpamTypes.arg list -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_dl_tool_opt : 
  OpamTypes.arg list option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_dl_jobs : int -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_dl_cache : 
  OpamTypes.url list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_wrappers : 
  OpamFile.Wrappers.t ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_global_variables : 
  (OpamTypes.variable * OpamTypes.variable_contents * string) list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_eval_variables : 
  (OpamTypes.variable * string list * string) list ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_validation_hook_opt : 
  OpamTypes.arg list option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_default_compiler : 
  OpamTypes.formula ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_default_invariant : 
  OpamTypes.formula ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_depext : bool -> OpamFile.Config.t -> OpamFile.Config.t

Sourceval with_depext_run_installs : bool -> OpamFile.Config.t -> OpamFile.Config.t

Sourceval with_depext_cannot_install : bool -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_depext_bypass : 
  OpamSysPkg.Set.t ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_sys_pkg_manager_cmd : 
  OpamTypes.filename OpamStd.String.Map.t ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval with_swh_fallback : bool -> OpamFile.Config.t -> OpamFile.Config.t

Source

val with_git_location : 
  OpamTypes.dirname ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Source

val with_git_location_opt : 
  OpamTypes.dirname option ->
  OpamFile.Config.t ->
  OpamFile.Config.t

Sourceval opam_version : OpamFile.Config.t -> OpamTypes.opam_version

Return the opam version

Sourceval opam_root_version : OpamFile.Config.t -> OpamTypes.opam_version

Return the opam root version, if not defined returns the default version value 2.1~~previous

Sourceval opam_root_version_opt : OpamFile.Config.t -> OpamTypes.opam_version option

Return the opam root version if defined

Sourceval repositories : OpamFile.Config.t -> OpamTypes.repository_name list

Return the list of repository

Sourceval switch : OpamFile.Config.t -> OpamTypes.switch option

Return the OCaml switch

Sourceval previous_switch : OpamFile.Config.t -> OpamTypes.switch option

Sourceval installed_switches : OpamFile.Config.t -> OpamTypes.switch list

Sourceval jobs : OpamFile.Config.t -> int option

Return the number of jobs defined

Sourceval dl_tool : OpamFile.Config.t -> OpamTypes.arg list option

Sourceval dl_jobs : OpamFile.Config.t -> int

Return the number of download jobs

Sourceval dl_cache : OpamFile.Config.t -> OpamTypes.url list

Sourceval criteria : OpamFile.Config.t -> (OpamTypes.solver_criteria * string) list

Sourceval best_effort_prefix : OpamFile.Config.t -> string option

Sourceval solver : OpamFile.Config.t -> OpamTypes.arg list option

Sourceval wrappers : OpamFile.Config.t -> OpamFile.Wrappers.t

Source

val global_variables : 
  OpamFile.Config.t ->
  (OpamTypes.variable * OpamTypes.variable_contents * string) list

variable, value, docstring

Source

val eval_variables : 
  OpamFile.Config.t ->
  (OpamTypes.variable * string list * string) list

variable, command, docstring

Sourceval validation_hook : OpamFile.Config.t -> OpamTypes.arg list option

Sourceval default_compiler : OpamFile.Config.t -> OpamTypes.formula

Sourceval default_invariant : OpamFile.Config.t -> OpamTypes.formula

Sourceval depext : OpamFile.Config.t -> bool

Sourceval depext_run_installs : OpamFile.Config.t -> bool

Sourceval depext_cannot_install : OpamFile.Config.t -> bool

Sourceval depext_bypass : OpamFile.Config.t -> OpamSysPkg.Set.t

Source

val sys_pkg_manager_cmd : 
  OpamFile.Config.t ->
  OpamTypes.filename OpamStd.String.Map.t

Sourceval swh_fallback : OpamFile.Config.t -> bool

Sourceval git_location : OpamFile.Config.t -> OpamTypes.dirname option

Source

val fields : 
  (string
   * (OpamFile.Config.t, OpamParserTypes.FullPos.value) OpamPp.field_parser)
    list

Source

val to_list : 
  ?filename:'a OpamFile.typed_file ->
  OpamFile.Config.t ->
  (string * OpamParserTypes.FullPos.value) list

All file fields as print-AST, Fields within sections are accessed through dot-separated paths

Sourcemodule BestEffort : OpamFile.BestEffortRead with type t := OpamFile.Config.t

Sourceval raw_root_version : 'a OpamFile.typed_file -> OpamVersion.t option

Raw read the config file to extract opam-root-version field value.

Module OpamFile.ConfigSource

Module `OpamFile.Config`Source