On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package opam-state
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Defines the file hierarchy in ~/.opam
Global paths
type t = OpamTypes.dirnameType of path root
val state_cache : t -> OpamTypes.filenameState cache
val lock : t -> OpamTypes.filenameGlobal lock file for the whole opamroot. Opam should generally read-lock this (e.g. initialisation and format upgrades require a write lock)
val config : t -> OpamFile.Config.t OpamFile.tMain configuration file: $opam/config
val init_config_file : unit -> OpamFile.InitConfig.t OpamFile.t optionGets an opam init config file, if present on the system (either ~/.opamrc or /etc/opamrc
val config_lock : t -> OpamTypes.filenameLock 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.dirnameArchives dir
val archive : t -> OpamTypes.package -> OpamTypes.filenameArchive file: $opam/archives/$NAME.$VERSION+opam.tar.gz
val repos_lock : t -> OpamTypes.filenameGlobal lock file for the repositories mirrors: $opam/repo/lock
val repos_config : t -> OpamFile.Repos_config.t OpamFile.tGlobal config file for the repositories mirrors: $opam/repo/repos-config
val init : t -> OpamTypes.dirnameInit scripts
val log : t -> OpamTypes.dirnameLog dir $opam/log
val download_cache : t -> OpamTypes.dirnamePrefix where to store the downloaded files cache $opam/download-cache
val backup_dir : t -> OpamTypes.dirnameThe directory where global backups are stored
val backup : t -> OpamTypes.switch_selections OpamFile.tBackup file for state export
module Switch : sig ... endSwitch related paths
module Builddir : sig ... endLocation of package-specific files relative to their build directory
On This Page