package opam-state

  1. Overview
  2. Docs

Module OpamFormatUpgradeSource

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

Sourceexception Upgrade_done of OpamFile.Config.t

Raised when the opam root has been updated to a newer format, and further action (opam init/update) is needed.

Sourceval latest_version : OpamVersion.t

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

Sourceval as_necessary : OpamSystem.lock -> OpamTypes.dirname -> OpamFile.Config.t -> unit

Runs the upgrade from its current format to the latest version for the opam root at the given directory. A global write lock must be supplied. If an upgrade has been done, raises Upgrade_done updated_config.

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

Sourceval comp_file : ?package:OpamTypes.package -> ?descr:OpamFile.Descr.t -> OpamFile.Comp.t -> OpamFile.OPAM.t

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