package opam-repository
Install
Dune Dependency
Authors
-
David Allsopp
-
VVincent Bernardoff <vb@luminar.eu.org>
-
RRaja Boujbel <raja.boujbel@ocamlpro.com>
-
KKate Deplaix <kit-ty-kate@outlook.com>
-
RRoberto Di Cosmo <roberto@dicosmo.org>
-
TThomas Gazagnaire <thomas@gazagnaire.org>
-
LLouis Gesbert <louis.gesbert@ocamlpro.com>
-
FFabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
-
AAnil Madhavapeddy <anil@recoil.org>
-
GGuillem Rieu <guillem.rieu@ocamlpro.com>
-
RRalf Treinen <ralf.treinen@pps.jussieu.fr>
-
FFrederic Tuong <tuong@users.gforge.inria.fr>
Maintainers
Sources
md5=e9a76b200b58d303507317e8d28f2a6d
sha512=410c662d6dbd289433c61ff36a8591c3df2f2dc1d0fd48bf69fbec9cf57ebc33fbe05e02096e26c91f7ff1485c00d77e7fddcd63e4c1f2293136312f5ddfbe05
doc/opam-repository/OpamRepository/index.html
Module OpamRepository
Source
Operations on repositories (update, fetch...) based on the different backends implemented in separate modules
Get the list of packages
Get the list of packages (and their possible prefix)
Repository backends
val update :
OpamTypes.repository ->
OpamTypes.dirname ->
[ `Changes | `No_changes ] OpamProcess.job
Update $opam/repo/$repo. Raises Failure
in case the update couldn't be achieved. Returns `No_changes
if the update did not bring any changes, and `Changes
otherwise.
pull_shared_tree ?cache_dir ?cache_url labels_dirnames checksums urls
Fetch an URL and put the resulting tree into the supplied directories specified in labels_dirnames
. The string in labels_dirnames
are text labels of this given dirname for display. urls
must either point to a tree (VCS, rsync) or to a known archive type. In case of an archive, the cache_dir
is used and supplied the hashes verified, then the archive uncompressed. In case of a version-controlled URL, it's checked out, or synchronised directly if local and working_dir
was set. cache_urls
is used to retrieve from repository caches.
val pull_tree :
string ->
?full_fetch:bool ->
?cache_dir:OpamTypes.dirname ->
?cache_urls:OpamTypes.url list ->
?working_dir:bool ->
?subpath:OpamTypes.subpath ->
OpamTypes.dirname ->
OpamHash.t list ->
OpamTypes.url list ->
string OpamTypes.download OpamProcess.job
val pull_file :
string ->
?cache_dir:OpamTypes.dirname ->
?cache_urls:OpamTypes.url list ->
?silent_hits:bool ->
OpamTypes.filename ->
OpamHash.t list ->
OpamTypes.url list ->
unit OpamTypes.download OpamProcess.job
Same as pull_tree
, but for fetching a single file.
val pull_file_to_cache :
string ->
cache_dir:OpamTypes.dirname ->
?cache_urls:OpamTypes.url list ->
OpamHash.t list ->
OpamTypes.url list ->
string OpamTypes.download OpamProcess.job
Same as pull_file
, but without a destination file: just ensures the file is present in the cache.
The file where the file with the given hash is stored under cache at given dirname.
Get the optional revision associated to a backend (git hash, etc.).
Get the version-control branch for that url. Only applicable for local, version controlled URLs. Returns None
in other cases.
Returns true if the url points to a local, version-controlled directory that has uncommitted changes
Find a backend
val report_fetch_result :
OpamTypes.package ->
string OpamTypes.download ->
unit OpamTypes.download
Prints user messages upon the result of a download