package opam-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Pretty-printing

package opam-lib

opam-lib
- OpamCompat
- OpamConsole
- OpamCoreConfig
- OpamFilename
  - Attribute
    
    Map
    
    Set
    
    Op
  - Base
    
    Map
    
    Set
    
    Op
  - Dir
    
    Map
    
    Set
    
    Op
  - Map
  - Op
  - Set
    
    Op
- OpamJson
- OpamParallel
  - G
    
    E
    
    Topological
    
    Vertex
  - GRAPH
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
  - Make
    
    G
    
    E
    
    Topological
    
    Vertex
  - MakeGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
    
    V
  - SIG
    
    G
    
    E
    
    Topological
    
    Vertex
  - VERTEX
- OpamProcess
  - Job
    
    Op
- OpamStd
  - ABSTRACT
    
    Map
    
    Set
    
    Op
  - AbstractString
    
    Map
    
    Set
    
    Op
  - Config
  - Env
  - Exn
  - Format
  - IntMap
  - IntSet
    
    Op
  - List
  - MAP
  - Map
    
    Make
    
    S
  - Op
  - Option
    
    Op
  - OrderedType
  - SET
    
    Op
  - Set
    
    Make
    
    Op
    
    S
  - String
    
    Map
    
    Set
    
    Op
    
    SetMap
    
    SetSet
    
    Op
  - Sys
- OpamSystem
- OpamVersion
  - Map
  - Set
    
    Op
- OpamVersionCompare
opam-lib.client
- OpamClient
  - API
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
  - SafeAPI
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
- OpamClientConfig
- OpamConfigCommand
- OpamPinCommand
- OpamRepositoryCommand
- OpamSwitchCommand
opam-lib.format
- OpamCompiler
  - Map
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamFile
  - Aliases
  - Comp
  - Compiler_index
  - Config
  - Descr
  - Dot_config
  - Dot_install
  - Export
  - File_attributes
  - Filenames
  - IO_FILE
  - Installed
  - Installed_roots
  - Lines
  - OPAM
  - Package_index
  - Pinned
  - Prefix
  - Reinstall
  - Repo
  - Repo_config
  - URL
- OpamFilter
- OpamFormat
- OpamFormatConfig
- OpamFormula
- OpamLexer
- OpamLineLexer
- OpamPackage
  - Graph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
  - Map
  - Name
    
    Map
    
    Set
    
    Op
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamParser
- OpamRepositoryName
  - Map
  - Set
    
    Op
- OpamSwitch
  - Map
  - Set
    
    Op
- OpamTypesBase
- OpamVariable
  - Full
    
    Map
    
    Set
    
    Op
  - Map
  - Set
    
    Op
opam-lib.repository
- OpamDarcs
  - B
- OpamDownload
- OpamGit
  - B
- OpamHTTP
  - B
- OpamHg
  - B
- OpamLocal
  - B
- OpamRepository
- OpamRepositoryBackend
  - S
- OpamRepositoryConfig
- OpamRepositoryPath
- OpamVCS
  - Make
    
    VCS
  - VCS
opam-lib.solver
- OpamActionGraph
  - ACTION
    
    Pkg
  - Make
    
    A
    
    Pkg
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
  - MakeAction
    
    P
    
    Pkg
  - SIG
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
- OpamCudf
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
  - Graph
  - Map
  - Set
    
    Op
- OpamHeuristic
- OpamSolver
  - Action
    
    Pkg
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    Vertex
    
    Topological
- OpamSolverConfig
opam-lib.state
- OpamAction
- OpamOCaml
- OpamPath
  - Switch
    
    Default
    
    Overlay
- OpamScript
- OpamSolution
- OpamState
  - Cache
  - Types
- OpamStateConfig

Legend:
Library
Module
Module type
Parameter
Class
Class type

Cudf interface

module Set : OpamStd.SET with type elt = Cudf.package

Cudf sets

module Map : OpamStd.MAP with type key = Cudf.package

Cudf maps

module Graph : sig ... end

Cudf graph

val diff : Cudf.universe -> Cudf.universe -> Set.t * Set.t

Computation of differences between universe. Returns the sets of packages to install and remove respectively.

module ActionGraph : OpamActionGraph.SIG with type package = Cudf.package

Cudf action graph

type conflict

Abstract type that may be returned in case of conflicts

val dependencies : Cudf.universe -> Cudf.package list -> Cudf.package list

Return the transitive closure of dependencies of set, sorted in topological order

val reverse_dependencies : 
  Cudf.universe ->
  Cudf.package list ->
  Cudf.package list

Return the transitive closure of dependencies of set, sorted in topological order

val check_request : 
  ?explain:bool ->
  version_map:int OpamPackage.Map.t ->
  Cudf.universe ->
  Cudf_types.vpkg OpamTypes.request ->
  (Cudf.universe, conflict) OpamTypes.result

Check if a request is satisfiable and return the reasons why not unless explain is set to false

val get_final_universe : 
  version_map:int OpamPackage.Map.t ->
  Cudf.universe ->
  Cudf_types.vpkg OpamTypes.request ->
  (Cudf.universe, conflict) OpamTypes.result

Compute the final universe state using the external solver.

val actions_of_diff : 
  (Set.t * Set.t) ->
  Cudf.package OpamTypes.atomic_action list

Compute the list of actions to match the difference between two universe. Remark: the result order is unspecified, ie. need to use atomic_actions to get a solution which respects the topological order induced by dependencies.

exception Cyclic_actions of Cudf.package OpamTypes.action list list

val atomic_actions : 
  simple_universe:Cudf.universe ->
  complete_universe:Cudf.universe ->
  [< Cudf.package OpamTypes.highlevel_action ] list ->
  ActionGraph.t

Computes the actions to process from a solution, from the actions obtained by a simple universe diff. The 'simple' universe should not contain build dependencies and will be used for resolution ; complete_universe should include build-deps, it's used to get the dependency ordering of actions.

Returns a graph of atomic actions, i.e. only removals and installs. Use reduce_actions to reduce it to a graph including reinstall and up/down-grade actions.

May raise Cyclic_actions.

val compute_root_causes : 
  ActionGraph.t ->
  OpamPackage.Name.Set.t ->
  Cudf.package OpamTypes.cause Map.t

Heuristic to compute the likely cause of all actions in a graph from the set of packages passed in the original request. Assumes a reduced graph.

val resolve : 
  extern:bool ->
  version_map:int OpamPackage.Map.t ->
  Cudf.universe ->
  Cudf_types.vpkg OpamTypes.request ->
  (Cudf.universe, conflict) OpamTypes.result

Resolve a CUDF request. The result is either a conflict holding an explanation of the error, or a resulting universe. ~extern specifies whether the external solver should be used

val to_actions : 
  (Cudf.universe -> Cudf.universe) ->
  Cudf.universe ->
  (Cudf.universe, conflict) OpamTypes.result ->
  (Cudf.package OpamTypes.atomic_action list, conflict) OpamTypes.result

Computes a list of actions to proceed from the result of resolve. Note however than the action list is not yet complete: the transitive closure of reinstallations is not yet completed, as it requires to fold over the dependency graph in considering the optional dependencies. The first argument specifies a function that will be applied to the starting universe before computation: useful to re-add orphan packages.

val remove : 
  Cudf.universe ->
  Cudf_types.pkgname ->
  Cudf_types.constr ->
  Cudf.universe

remove universe name constr Remove all the packages called name satisfying the constraints constr in the universe universe.

val uninstall_all : Cudf.universe -> Cudf.universe

Uninstall all the package in the universe.

val install : Cudf.universe -> Cudf.package -> Cudf.universe

Install a package in the universe. We don't care about any invariant here (eg. the resulting universe can have mutliple versions of the same package installed).

val remove_all_uninstalled_versions_but : 
  Cudf.universe ->
  string ->
  Cudf_types.constr ->
  Cudf.universe

Remove all the versions of a given package, but the one given as argument.

val s_source : string

Cudf labels for package fields in the cudf format (use for the field Cudf.pkg_extra and with Cudf.lookup_package_property)

the original OPAM package name (as string)

val s_source_number : string

the original OPAM package name (as string)

the original OPAM package version (as string)

val s_reinstall : string

the original OPAM package version (as string)

a package to be reinstalled (a bool)

val s_installed_root : string

a package to be reinstalled (a bool)

true if this package belongs to the roots ("installed manually") packages

val s_pinned : string

true if this package belongs to the roots ("installed manually") packages

true if the package is pinned to this version

val s_version_lag : string

true if the package is pinned to this version

the number of versions of the package since this one

Pretty-printing

val string_of_vpkgs : Cudf_types.vpkg list -> string

Convert a package constraint to something readable.

val make_conflicts : 
  version_map:int OpamTypes.package_map ->
  Cudf.universe ->
  Algo.Diagnostic.diagnosis ->
  ('a, conflict) OpamTypes.result

val cycle_conflict : 
  version_map:int OpamTypes.package_map ->
  Cudf.universe ->
  string list list ->
  ('a, conflict) OpamTypes.result

val string_of_conflict : (OpamTypes.atom -> string) -> conflict -> string

Convert a conflict to something readable by the user. The first argument should return a string like "lwt<3.2.1 is not available because..." when called on an unavailable package (the reason can't be known this deep in the solver)

val strings_of_conflict : 
  (OpamTypes.atom -> string) ->
  conflict ->
  string list * string list * string list

Returns three lists of strings:

the final reasons why the request can't be satisfied
the dependency chains explaining it
the cycles in the actions to process (exclusive with the other two)

val conflict_chains : conflict -> OpamFormula.t list list

val dump_universe : Stdlib.out_channel -> Cudf.universe -> unit

Dumps the given cudf universe to the given channel

val string_of_atom : Cudf_types.vpkg -> string

Pretty-print atoms

val string_of_request : Cudf_types.vpkg OpamTypes.request -> string

Pretty-print requests

val string_of_universe : Cudf.universe -> string

Pretty-print the universe

val string_of_packages : Cudf.package list -> string

Pretty-print of packages

val cudf2opam : Cudf.package -> OpamTypes.package

Convert a cudf package back to an OPAM package

val packages : Cudf.universe -> Cudf.package list

Returns the list of packages in a Cudf universe

val external_solver_available : unit -> bool

External solver

val to_cudf : 
  Cudf.universe ->
  Cudf_types.vpkg OpamTypes.request ->
  Cudf.preamble * Cudf.universe * Cudf.request

Converts an OPAM request to a Cudf request