package opam-state

  1. Overview
  2. Docs
State library for opam 2.4

Install 

dune-project
 Dependency

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

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.4.0.tar.gz
md5=f509aa3ca69423d6f4fc8c703f78a566
sha512=4a52fa74e2a3b975623f6eac169042d1ca9e18ec77693a8f24d0eb59c97737b3bb8e659d609e283c293ce6eef4395a9eda20b317d30a88dfa8b88171694b1660

doc/opam-state/OpamFormatUpgrade/index.html

Module OpamFormatUpgradeSource

This modules handles the conversion from older repository and package versions to the current one

Sourceexception Upgrade_done of OpamFile.Config.t * (OpamFile.Config.t -> unit) option

Raised when the opam root has been updated to a newer format, and further action (opam init/update) is needed. Upgrade_done conf reinit specifies the new config file and a reinit function to call instead of default (see OpamCliMain.main_catch_all).

Sourceval latest_version : OpamVersion.t

The latest version of the opam root format, that normal operation of this instance of opam requires

as_necessary requested_lock global_lock root config Runs the upgrade from its current format to the latest compatible version for the opam root at root directory. Performs an on-the-fly upgrade (loaded state, not written) if possible: no hard upgrade needed, and no write lock required (requested_lock). If upgrade need to be written (hard upgrade), a write lock on the global state (global_lock) is taken and when it's done raises Upgrade_done updated_config. Otherwise, it returns the upgraded or unchanged config file and a status of remaining upgrades.

Sourceval as_necessary_repo_switch_light_upgrade : 'a OpamStateTypes.lock -> [ `Repo | `Switch ] -> 'b OpamStateTypes.global_state -> unit
Sourceval hard_upgrade_from_2_1_intermediates : ?reinit:(OpamFile.Config.t -> unit) -> ?global_lock:OpamSystem.lock -> OpamTypes.dirname -> unit
Sourceval opam_file_from_1_2_to_2_0 : ?filename:OpamFile.OPAM.t OpamFile.t -> OpamFile.OPAM.t -> OpamFile.OPAM.t

Converts the opam file format, including rewriting availability conditions based on OCaml-related variables into dependencies. The filename is used to report errors

Sourceval opam_file : ?quiet:bool -> ?filename:OpamFile.OPAM.t OpamFile.t -> OpamFile.OPAM.t -> OpamFile.OPAM.t

Runs the opam file format from the file's format to current. Supplying filename enables additional notification messages

Convert the comp file to an opam one, using OpamFile.Comp.to_package and applying filter rewriting

Sourceval opam_file_with_aux : ?quiet:bool -> ?dir:OpamTypes.dirname -> files:bool -> ?filename:OpamFile.OPAM.t OpamFile.t -> OpamFile.OPAM.t -> OpamFile.OPAM.t

Runs the opam file format from the file's format to current, and adds data from 'url' and 'descr' files found in the specified dir or the opam file's metadata dir, if not already present in the opam file. If files is true, also adds the names and hashes of files found below 'files/'. Supplying filename enables additional notification messages