package opam-client

  1. Overview
  2. Docs
On This Page
  1. Atoms
Client library for opam 2.5

Install 

dune-project
 Dependency

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

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-rc1.tar.gz
md5=fc3e769ecf6acee13e249d6d1ab52b60
sha512=b57536f4530ed03c8f3cc8cf814af9a2c53b159f58fc1b50be93295f6eb8d53faeef3d916e1a3f5137d35468af15fc2f59a2f8bda5c574532ab523fd945b9781

doc/opam-client/OpamSolution/index.html

Module OpamSolutionSource

Interface with the solver, processing of full solutions through actions

Resolve an user request

Sourceval apply : ?ask:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> requested:OpamTypes.package_set -> ?print_requested:OpamPackage.Name.Set.t -> ?add_roots:OpamPackage.Name.Set.t -> ?skip:OpamTypes.package OpamPackage.Map.t -> ?assume_built:bool -> ?download_only:bool -> ?force_remove:bool -> OpamSolver.solution -> OpamStateTypes.rw OpamStateTypes.switch_state * OpamTypes.solution_result

Apply a solution returned by the solver. If ask is not specified, prompts the user whenever the solution isn't obvious from the request. add_roots defaults to the set of newly installed packages that are part of requested. If force_remove is true, modified files are not kept. skip will ignore the actions on the supplied map keys, replacing them with the map values when printing. print_requested is the set of initially requested packages, used for printing actions reasons.

Call the solver to get a solution and then call apply. If ask is not specified, prompts the user whenever the solution isn't obvious from the request. add_roots defaults to the set of newly installed packages that are part of requested. If force_remove is true, modified files are not kept. print_requested is the set of initially requested packages, used for printing actions reasons.

Sourceval check_solution : ?quiet:bool -> 'a OpamStateTypes.switch_state -> (OpamTypes.solution_result, 'conflict) OpamTypes.result -> unit

Raise an error if no solution is found or in case of error. Unless quiet is set, print a message indicating that nothing was done on an empty solution.

Simulate the new switch_state after applying the solution without actually performing the action(s) on disk.

Sourceval print_depext_msg : OpamSysPkg.status -> unit

Given OpamSysPkg.status (see OpamSysInteract.packages_status), displays appropriate warnings/messages on the console if either set is non-empty.

Sourceval install_sys_packages : confirm:bool -> OpamStateTypes.gt_variables -> OpamFile.Config.t -> OpamSysPkg.to_install -> unit -> unit

As install_depexts, but supplied with a set of system packages to be installed.

Sourceval install_depexts : ?force_depext:bool -> ?confirm:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> pkg_to_install:OpamTypes.package_set -> pkg_installed:OpamTypes.package_set -> OpamStateTypes.rw OpamStateTypes.switch_state

Atoms

Return an atom with a strict version constraint

Sourceval atom_of_package : OpamTypes.package -> OpamTypes.atom

Return a simple atom, with no version constraint, from a package

Sourceval eq_atom_of_package : OpamTypes.package -> OpamTypes.atom

Returns an atom with a strict version constraint from a package

Sourceval atoms_of_packages : OpamTypes.package_set -> OpamTypes.atom list

Return a list of simple atoms (ie. with no version constraints) from a set of packages

Sourceval eq_atoms_of_packages : OpamTypes.package_set -> OpamTypes.atom list

Return a list of constrained atoms from a set of packages

Sourceval check_availability : ?permissive:bool -> 'a OpamStateTypes.switch_state -> OpamPackage.Set.t -> OpamTypes.atom list -> unit

Checks that the atoms can possibly be verified (individually) in a package set. Displays an error and exits otherwise. permissive just changes the error message.

Matches package names to their existing counterparts, up to capitalisation. If no match exists, returns the name unchanged.

Sourceval sanitize_atom_list : ?permissive:bool -> ?installed:bool -> 'a OpamStateTypes.switch_state -> OpamTypes.atom list -> OpamTypes.atom list

Takes a "raw" list of atoms (from the user), and match it to existing packages. Match packages with the wrong capitalisation, and raises errors on non-existing packages, and unavailable ones unless permissive is set. installed additionally accepts installed, but unavailable packages. Exits with a message on error.

Sourceval sum : OpamTypes.stats -> int

Stats