module OpamRepository: sig
.. end
Mangagement of OPAM repositories.
include OpamMisc.ABSTRACT
exception Unknown_backend
val default_address : OpamTypes.address
Default repository address
val to_string : OpamTypes.repository -> string
Pretty-print
val compare : OpamTypes.repository -> OpamTypes.repository -> int
Compare repositories
val default : unit -> OpamTypes.repository
Default repository
val local : OpamTypes.dirname -> OpamTypes.repository
Create a local repository on a given path
val packages : OpamTypes.repository -> OpamTypes.package_set
Get the list of packages
val packages_with_prefixes : OpamTypes.repository -> string option OpamTypes.package_map
Get the list of packages (and their eventual prefixes)
val compilers : OpamTypes.repository -> OpamTypes.compiler_set
Get the list of all compiler
val compilers_with_prefixes : OpamTypes.repository -> string option OpamTypes.compiler_map
Get the list of compilers (and their eventual prefixes)
Repository Collection Operations
val sort : OpamTypes.repository OpamTypes.repository_name_map ->
OpamTypes.repository list
Sort a collection of repositories by priority
val package_index : OpamTypes.repository OpamTypes.repository_name_map ->
(OpamTypes.repository_name * string option) OpamTypes.package_map
Generate a package index from a collection of repositories
val compiler_index : OpamTypes.repository OpamTypes.repository_name_map ->
(OpamTypes.repository_name * string option) OpamTypes.compiler_map
Generate a compiler index from a collection of repositories
State
val package_files : OpamTypes.repository ->
string option -> OpamTypes.package -> archive:bool -> OpamTypes.filename list
Get all the package files
val package_state : OpamTypes.repository ->
string option ->
OpamTypes.package -> [ `all | `partial of bool ] -> OpamTypes.checksums
Compute a package state (ie. a list of checksums).
val compiler_files : OpamTypes.repository ->
string option -> OpamTypes.compiler -> OpamTypes.filename list
Get all the compiler files
val compiler_state : OpamTypes.repository ->
string option -> OpamTypes.compiler -> OpamTypes.checksums
Compute a compiler state (ie. a list of checksums).
Repository backends
val init : OpamTypes.repository -> unit
Initialize $opam/repo/$repo
val update : OpamTypes.repository -> unit
Update $opam/repo/$repo.
module type BACKEND = sig
.. end
Backend signature
val pull_url : OpamTypes.repository_kind ->
OpamTypes.package ->
OpamTypes.dirname ->
string option ->
OpamTypes.address -> OpamTypes.generic_file OpamTypes.download
Download an url
val pull_url_and_fix_digest : OpamTypes.repository_kind ->
OpamTypes.package ->
OpamTypes.dirname ->
string ->
OpamTypes.filename ->
OpamTypes.address -> OpamTypes.generic_file OpamTypes.download
Pull and fix the resulting digest
val check_digest : OpamTypes.filename -> string option -> unit
check_digest file expected
check that the file
digest is the
one expected
.
val pull_archive : OpamTypes.repository ->
OpamTypes.package -> OpamTypes.filename OpamTypes.download
Pull an archive in a repository
val revision : OpamTypes.repository -> OpamTypes.version option
Get the optional revision associated to a backend.
val make_archive : ?gener_digest:bool ->
OpamTypes.repository -> string option -> OpamTypes.package -> unit
make_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 register_backend : OpamTypes.repository_kind -> (module OpamRepository.BACKEND) -> unit
Register a repository backend
val find_backend : OpamTypes.repository_kind -> (module OpamRepository.BACKEND)
Find a backend
Misc
module Parallel: OpamParallel.SIG
with type G.V.t = repository
Parallel iterations