package opam-0install

  1. Overview
  2. Docs
Opam solver using 0install backend

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (10)

Authors

  1. T
    talex5@gmail.com

Maintainers

  1. T
    talex5@gmail.com

Sources

opam-0install-cudf-v0.3.tbz
sha256=26cacd296641278384dc7357560e3b13aca1269d406c9fd0c5f0b1132d8ccdf8
sha512=9d0a51adfecd143b575cb1a0615c527e19ba4748dbe338c442c1974ca4707e39a56de96e5c937df53cb185f442914646226b3ec0a4df50303e1d1a3eed695fa2

doc/opam-0install/Opam_0install/Dir_context/index.html

Module Opam_0install.Dir_contextSource

A context that reads opam files directly from an opam-repository checkout. It does not use a switch, and therefore does not pick up any pins the user has set. It also does not get any opam variables from the environment - instead, the caller must provide them explicitly.

include S.CONTEXT
Sourcetype t
Sourcetype rejection

A reason why a package can't be used as input to the solver. e.g. it is for a different platform, or conflicts with a user-provided constraint.

Sourceval pp_rejection : rejection Fmt.t
Sourceval candidates : t -> OpamPackage.Name.t -> (OpamPackage.Version.t * (OpamFile.OPAM.t, rejection) result) list

candidates t name is the list of available versions of name, in order of decreasing preference. If the user or environment provides additional constraints that mean a version should be rejected, include that here too. Rejects are only used for generating diagnostics reports. Candidates whose "availablity" field isn't satisfied must be rejected here.

Sourceval user_restrictions : t -> OpamPackage.Name.t -> OpamFormula.version_constraint option

user_restrictions t pkg is the user's constraint on pkg, if any. This is just used for diagnostics; you still have to filter them out yourself in candidates.

Sourceval filter_deps : t -> OpamPackage.t -> OpamTypes.filtered_formula -> OpamTypes.formula

filter_deps t pkg f is used to pre-process depends and conflicts. pkg is the package which has the dependency f. For example, you can use this to filter out dependencies that are only needed on Windows if the platform is Linux.

Sourceval std_env : ?ocaml_native:bool -> ?sys_ocaml_version:string -> arch:string -> os:string -> os_distribution:string -> os_family:string -> os_version:string -> unit -> string -> OpamVariable.variable_contents option

std_env ~arch ~os ~os_distribution ~os_family ~os_version is an environment function that returns the given values for the standard opam variables, and None for anything else.

Sourceval create : ?prefer_oldest:bool -> ?test:OpamPackage.Name.Set.t -> ?pins:(OpamTypes.version * OpamFile.OPAM.t) OpamTypes.name_map -> constraints:OpamFormula.version_constraint OpamTypes.name_map -> env:(string -> OpamVariable.variable_contents option) -> string -> t

create ~constraints ~env packages_dir is a solver that gets candidates from packages_dir, filtering them using constraints. packages_dir contains one sub-directory for each package name, each with subdirectories for each version, in the same format used by opam-repository.

  • parameter test

    Packages for which we should include "with-test" dependencies.

  • parameter pins

    Packages in this map have only the given candidate version and opam file.

  • parameter env

    Maps opam variable names to values (std_env may be useful here). "version" and the OpamPackageVar.predefined_depends_variables are handled automatically.

  • parameter prefer_oldest

    if true the solver is set to return the least up-to-date version of each package, if a solution exists. This is false by default.

    @before 0.4

    the prefer_oldest parameter did not exist.