package opam-lib
Install
Dune Dependency
Authors
-
TThomas Gazagnaire <thomas@gazagnaire.org>
-
AAnil Madhavapeddy <anil@recoil.org>
-
FFabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
-
FFrederic Tuong <tuong@users.gforge.inria.fr>
-
LLouis Gesbert <louis.gesbert@ocamlpro.com>
-
GGuillem Rieu <guillem.rieu@ocamlpro.com>
-
VVincent Bernardoff <vb@luminar.eu.org>
-
RRoberto Di Cosmo <roberto@dicosmo.org>
Maintainers
Sources
sha256=625767c3465219cc8799aad1449c74279b31686db0821300cfdb92fbff17e9fd
md5=e0688c0cf9a55f93ee93f62d07cf6b74
doc/opam-lib.repository/OpamRepository/index.html
Module OpamRepository
Defines on-disk package repositories, synchronised with an upstream
val packages : OpamTypes.repository -> OpamTypes.package_setGet the list of packages
val packages_with_prefixes :
OpamTypes.repository ->
string option OpamTypes.package_mapGet the list of packages (and their eventual prefixes)
val compilers : OpamTypes.repository -> OpamTypes.compiler_setGet the list of all compiler
val compilers_with_prefixes :
OpamTypes.repository ->
string option OpamTypes.compiler_mapGet the list of compilers (and their eventual prefixes)
Repository Collection Operations
val sort :
OpamTypes.repository OpamTypes.repository_name_map ->
OpamTypes.repository listSort a collection of repositories by priority
val package_index :
OpamTypes.repository OpamTypes.repository_name_map ->
(OpamTypes.repository_name * string option) OpamTypes.package_mapGenerate a package index from a collection of repositories
val compiler_index :
OpamTypes.repository OpamTypes.repository_name_map ->
(OpamTypes.repository_name * string option) OpamTypes.compiler_mapGenerate a compiler index from a collection of repositories
State
val url_checksum : OpamFilename.t -> OpamTypes.checksumsGet the package archive checksum off an url file
val package_files :
OpamTypes.repository ->
string option ->
OpamTypes.package ->
archive:bool ->
OpamTypes.filename listGet all the package files
val package_state :
OpamTypes.repository ->
string option ->
OpamTypes.package ->
[ `all | `partial of bool ] ->
OpamTypes.checksumsCompute a package state (ie. a list of checksums). If `partial archive, only the checksum of the archive within the url file (instead of the file itself), of the files/ subdirectory, and of the archive if set are returned.
val compiler_files :
OpamTypes.repository ->
string option ->
OpamTypes.compiler ->
OpamTypes.filename listGet all the compiler files
val compiler_state :
OpamTypes.repository ->
string option ->
OpamTypes.compiler ->
OpamTypes.checksumsCompute a compiler state (ie. a list of checksums).
Repository backends
val init : OpamTypes.repository -> unit OpamProcess.jobInitialize $opam/repo/$repo
val update : OpamTypes.repository -> unit OpamProcess.jobUpdate $opam/repo/$repo.
val check_version : OpamTypes.repository -> unit OpamProcess.jobError and exit on incompatible version
val pull_url :
OpamTypes.repository_kind ->
OpamTypes.package ->
OpamTypes.dirname ->
string option ->
OpamTypes.address list ->
OpamTypes.generic_file OpamTypes.download OpamProcess.jobDownload an url. Several mirrors can be provided, in which case they will be tried in order in case of an error.
val pull_url_and_fix_digest :
OpamTypes.repository_kind ->
OpamTypes.package ->
OpamTypes.dirname ->
string ->
OpamTypes.filename ->
OpamTypes.address list ->
OpamTypes.generic_file OpamTypes.download OpamProcess.jobPull and fix the resulting digest
val pull_archive :
OpamTypes.repository ->
OpamTypes.package ->
OpamTypes.filename OpamTypes.download OpamProcess.jobPull an archive in a repository
val revision : OpamTypes.repository -> OpamTypes.version option OpamProcess.jobGet the optional revision associated to a backend.
val make_archive :
?gener_digest:bool ->
OpamTypes.repository ->
string option ->
OpamTypes.package ->
unit OpamProcess.jobmake_archive ?gener_digest repo prefix package builds the archive for the given package. By default, the digest that appears in $NAME.$VERSION/url is not modified, unless gener_digest is set.
val find_backend : OpamTypes.repository -> (module OpamRepositoryBackend.S)Find a backend
val find_backend_by_kind :
OpamTypes.repository_kind ->
(module OpamRepositoryBackend.S)