package opam-client

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

Install 

dune-project
 Dependency

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

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.1.1.tar.gz
md5=e1202a21d669d460b9fa852e39f0502e
sha512=fb46bc8f12e49c2da95c5f8669f55fb93710ee826827538852c3091ec2c714c082137373fa9e1ad3f53f107b1fae6c2abd0b6e5f84f7756bd3b38e57978f080e

doc/opam-client/OpamSolution/index.html

Module OpamSolutionSource

Interface with the solver, processing of full solutions through actions

Sourceval resolve : 'a OpamStateTypes.switch_state -> OpamTypes.user_action -> orphans:OpamTypes.package_set -> ?reinstall:OpamTypes.package_set -> requested:OpamTypes.name_set -> OpamTypes.atom OpamTypes.request -> (OpamSolver.solution, OpamCudf.conflict) OpamTypes.result

Resolve an user request

Sourceval apply : ?ask:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> requested:OpamPackage.Name.Set.t -> ?add_roots:OpamPackage.Name.Set.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.

Sourceval resolve_and_apply : ?ask:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.user_action -> orphans:OpamTypes.package_set -> ?reinstall:OpamTypes.package_set -> requested:OpamPackage.Name.Set.t -> ?add_roots:OpamPackage.Name.Set.t -> ?assume_built:bool -> ?download_only:bool -> ?force_remove:bool -> OpamTypes.atom OpamTypes.request -> OpamStateTypes.rw OpamStateTypes.switch_state * (OpamTypes.solution_result, OpamCudf.conflict) OpamTypes.result

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.

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.

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

Atoms

Sourceval eq_atom : OpamTypes.name -> OpamTypes.version -> OpamTypes.atom

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.

Sourceval fuzzy_name : 'a OpamStateTypes.switch_state -> OpamTypes.name -> OpamTypes.name

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

Sourceval sanitize_atom_list : ?permissive: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. Exits with a message on error.

Sourceval sum : OpamTypes.stats -> int

Stats