package opam-format

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

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

2.0.1.tar.gz
md5=1e55c234fa09e678e8115a31f3ec2a05
sha512=d71c362d70a6b6cb9fe54cc43bfbea8079cca05d4721a7dda951196f543a1ff5af81399a246e0cd68bc590c7bdca388d96c7127217ed637261957047ce725516

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

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 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 archives_dir : t -> OpamTypes.dirname

Archives dir

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

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

Sourcemodule Switch : sig ... end

Switch related paths

Sourcemodule Builddir : sig ... end

Location of package-specific files relative to their build directory