package opam-state

  1. Overview
  2. Docs
State library for opam 2.5

Install 

dune-project
 Dependency

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

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.0.tar.gz
md5=79d057547b7114e31334bc4f556bc541
sha512=707b652997bae086003c4164029ed40a68e9c465b4ce1731d0f8ccc0a496c5b6d9011e45bc2b6f73e56d316e54bce7c82becb83bd7de4fa53b0795ad7ae7032a

doc/opam-state/OpamGlobalState/index.html

Module OpamGlobalStateSource

Loading and handling of the global state of an opam root

Loads the global state (from the opam root obtained through OpamStateConfig.(!r.root))

Sourceval with_ : 'a OpamStateTypes.lock -> ('a OpamStateTypes.global_state -> 'b) -> 'b

Loads the global state as load, and calls the given function while keeping it locked (as per the lock argument), releasing the lock afterwards

The set of all installed packages, in any switch

Sourceval fold_switches : (OpamTypes.switch -> OpamTypes.switch_selections -> 'a -> 'a) -> 'b OpamStateTypes.global_state -> 'a -> 'a

Fold over switches, using switch selections. Switch selection file switch-state is loaded only read-only; no further checks are done on the opam root version.

Sourceval switch_exists : 'a OpamStateTypes.global_state -> OpamTypes.switch -> bool

Checks a switch for existence: either configured in the opam root, or an existing local switch with a configuration file pointing to the current root

Returns the map of installed instances of the package name towards the list of switches they are installed in

Default list of repositories to get packages from, ordered by decreasing priority. This can be overridden by switch-specific selections, and does not have to include all configured repositories.

Releases any locks on the given global_state

Sourceval drop : 'a OpamStateTypes.global_state -> unit

Releases any locks on the given global state and then ignores it.

Using drop gt is equivalent to ignore (unlock gt), and safer than other uses of ignore where it is not enforced by the type-system that the value is unlocked before it is lost.

Calls the provided function, ensuring a temporary write lock on the given global state

Writes back the global configuration file ~/.opam/config

Updates the configured list of switches, making sure the current switch is registered if it is set and exists, and removing any non-existing switches. Writes back to disk if possible (ie lock is available)

Sourceval inferred_from_system : string

Description used for system inferred variables