package opam-format

  1. Overview
  2. Docs
On This Page
  1. Global paths
Format library for opam 2.5

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (34)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

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

Sources

2.5.1.tar.gz
md5=ec79947463f8be9efa11abd765091682
sha512=213f65253e12db5e64ece137db48eb031acb683ac3c0ecd3c02d1127a55777ef2d47298ebdffcdbb8c55a3a08ab0ec0a675698b05d72a3fd1649c89af8fdd150

doc/opam-format/OpamPath/index.html

Module OpamPathSource

Defines the file hierarchy in ~/.opam

Global paths

Type of path root

Sourceval state_cache : t -> OpamTypes.filename

State cache

Sourceval state_cache_dir : t -> OpamTypes.dirname

Directory containing state cache

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

Sourceval redirected : t -> OpamFilename.t

Redirection file for opam root: $opam/redirected-opamroot

Sourceval 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.

Sourceval 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)

Sourceval repos_lock : t -> OpamTypes.filename

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

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

Init scripts location: $opam/opam-init

Sourceval hooks_dir : t -> OpamTypes.dirname

Installation dir for configured hooks: $$opam/opam-init/hooks

Log dir $opam/log

Sourceval backup_dir : t -> OpamTypes.dirname

The directory where global backups are stored

Backup file for state export

Sourceval plugin_prefix : string

The prefix for plugin commands ("opam-")

Sourceval plugins : t -> OpamTypes.dirname

The directory for plugins data $opam/plugins

Sourceval plugins_bin : t -> OpamTypes.dirname

The directory for shared plugin binaries $opam/plugins/bin

The globally installed binary of the given plugin $opam/plugins/bin/opam-foo

The directory for a given plugin's data $opam/plugins/$name. "bin" is forbidden.

Sourceval last_env : t -> OpamTypes.dirname

The last environment used regardless the switch

Sourcemodule type LAYOUT = sig ... end
Sourcemodule Switch : sig ... end

Switch related paths

Sourcemodule Builddir : sig ... end

Location of package-specific files relative to their build directory