package opam-lib

  1. Overview
  2. Docs
On This Page
  1. Global paths
package opam-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

The various paths where OPAM configuration files are stored.

Global paths

Type of path root

val state_cache : t -> OpamTypes.filename

State cache

val update_cache : t -> OpamTypes.filename

Update cache

val lock : t -> OpamTypes.filename

lock file

val config : t -> OpamTypes.filename

Main configuration file: $opam/config

val aliases : t -> OpamTypes.filename

Compiler aliases

val packages_dir : t -> OpamTypes.dirname

Package directroy $opam/packages/

Package sub-directory $opam/packages/$NAME/$NAME.$VERSION/

OPAM files: $opam/packages/$NAME/$NAME.$VERSION/opam

URL files: $opam/packages/$NAME/$NAME.$VERSION/url

Additional files: $opam/packages/$NAME/$NAME.$VERSION/files

val dev_packages_dir : t -> OpamTypes.dirname

Temporary folder for dev packages $opam/packages.dev/

val dev_package : t -> OpamTypes.package -> OpamTypes.dirname

Temporary folder for dev packages $opam/packages.dev/$NAME.$VERSION/

Description file: $opam/packages/$NAME/$NAME.$VERSION/descr

val archives_dir : t -> OpamTypes.dirname

Archives dir

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

val compiler_comp : t -> OpamTypes.compiler -> OpamTypes.filename

Compiler files: $opam/compilers/$VERSION/$COMP.comp

val compiler_descr : t -> OpamTypes.compiler -> OpamTypes.filename

Compiler description files: $opam/compilers/$VERSION/$COMP.descr

val compilers_dir : t -> OpamTypes.dirname

Compiler files: $opam/compilers/

val compilers : t -> OpamTypes.compiler -> OpamTypes.dirname

Compiler subdir $opam/compilers/$VERSION/$COMP

val package_index : t -> OpamTypes.filename

Return the repository index: $opam/repo/package-index

val compiler_index : t -> OpamTypes.filename

Return the repository index: $opam/repo/compiler-index

val init : t -> OpamTypes.dirname

Init scripts

val log : t -> OpamTypes.dirname

Log dir $opam/log

val backup_dir : t -> OpamTypes.dirname

The directory where global backups are stored

val backup : t -> OpamTypes.filename

Backup file for state export

module Switch : sig ... end

Switch related paths