package opam-state

  1. Overview
  2. Docs
On This Page
  1. Global paths

Defines the file hierarchy in ~/.opam

Global paths

Type of path root

val state_cache : t -> OpamTypes.filename

State cache

val lock : t -> OpamTypes.filename

Global lock file for the whole opamroot. Opam should generally read-lock this (e.g. initialisation and format upgrades require a write lock)

Main configuration file: $opam/config

val init_config_files : unit -> OpamFile.InitConfig.t OpamFile.t list

The list of configuration files location used by default (/etc/opamrc and ~/.opamrc). More general (lower priority) first.

val config_lock : t -> OpamTypes.filename

Lock for updates on the main config file (write lock when changes to switches, repositories lists are expected. No lock needed otherwise)

val archives_dir : t -> OpamTypes.dirname

Archives dir

Archive file: $opam/archives/$NAME.$VERSION+opam.tar.gz

val repos_lock : t -> OpamTypes.filename

Global lock file for the repositories mirrors: $opam/repo/lock

val repos_config : t -> OpamFile.Repos_config.t OpamFile.t

Global config file for the repositories mirrors: $opam/repo/repos-config

val init : t -> OpamTypes.dirname

Init scripts

val log : t -> OpamTypes.dirname

Log dir $opam/log

val download_cache : t -> OpamTypes.dirname

Prefix where to store the downloaded files cache $opam/download-cache

val backup_dir : t -> OpamTypes.dirname

The directory where global backups are stored

Backup file for state export

module Switch : sig ... end

Switch related paths

module Builddir : sig ... end

Location of package-specific files relative to their build directory