package opam-lib

  1. Overview
  2. Docs
On This Page
  1. Global paths
The OPAM library

Install 

dune-project
 Dependency

opam.ocaml.org Edit opam file Versions (1)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  2. A
    Anil Madhavapeddy <anil@recoil.org>
  3. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  4. F
    Frederic Tuong <tuong@users.gforge.inria.fr>
  5. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  6. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  7. V
    Vincent Bernardoff <vb@luminar.eu.org>
  8. R
    Roberto Di Cosmo <roberto@dicosmo.org>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

1.3.1.tar.gz
sha256=625767c3465219cc8799aad1449c74279b31686db0821300cfdb92fbff17e9fd
md5=e0688c0cf9a55f93ee93f62d07cf6b74

doc/opam-lib.state/OpamPath/index.html

Module OpamPath

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