Module `OpamFile`

Functions to read and write OPAM configuration files in a typed way

module type IO_FILE = sig ... end

All Configuration files satisfies this signature

module Lines : IO_FILE with type t = string list list

Lines of space-separated words.

module Config : sig ... end

Configuration file: $opam/config

module OPAM : sig ... end

OPAM files

module Descr : sig ... end

Package descriptions: $opam/descr/

module Aliases : IO_FILE with type t = OpamTypes.compiler OpamTypes.switch_map

Compiler aliases: $opam/aliases

module Export : 
  IO_FILE
    with type t =
           OpamTypes.package_set
           * OpamTypes.package_set
           * OpamTypes.pin_option OpamPackage.Name.Map.t

Import/export file. This difference with installed is that we are explicit about root packages.

module Installed : IO_FILE with type t = OpamTypes.package_set

List of installed packages: $opam/$oversion/installed

module Installed_roots : IO_FILE with type t = OpamTypes.package_set

List of packages explicitly installed by the user: $opam/$switch/installed.user

module Reinstall : IO_FILE with type t = OpamTypes.package_set

List of packages to reinstall: $opam/$oversion/reinstall

module Comp : sig ... end

Compiler version $opam/compilers/

Configuration files

module Dot_install : sig ... end

.install files

module Dot_config : sig ... end

.config files

Repository files

module Package_index : 
  IO_FILE
    with type t =
           (OpamTypes.repository_name * string option) OpamTypes.package_map

Association between package names and repositories

module Compiler_index : 
  IO_FILE
    with type t =
           (OpamTypes.repository_name * string option) OpamTypes.compiler_map

Association between compiler names and repositories

module Repo_config : IO_FILE with type t = OpamTypes.repository

Repository config: $opam/repo/$repo/config

module Pinned : IO_FILE with type t = OpamTypes.pin_option OpamTypes.name_map

Pinned package files

module Repo : sig ... end

Repository metadata

Substitution files

module URL : sig ... end

module File_attributes : IO_FILE with type t = OpamTypes.file_attribute_set

module Filenames : IO_FILE with type t = OpamTypes.filename_set

List of filenames

module Prefix : IO_FILE with type t = string OpamTypes.name_map

Prefix of package directories

val print_stats : unit -> unit

Display statistics about file access.

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/opam-lib.format/OpamFile/index.html

Module `OpamFile`

Configuration files

Repository files

Substitution files

package opam-lib

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/opam-lib.format/OpamFile/index.html

Module OpamFile

Configuration files

Repository files

Substitution files

dune-project
Dependency

Module `OpamFile`