package opam-repository
Install
dune-project
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=0fb8e9f62683772592b1bc2d80a763b8
sha512=1c617b1c1656817a47ef65d02fc990357476f6c1b406c02717e5ff702a2c42e9f3818c2ddd54470926b2c5344c1c285216471a684d261be7a3ec84b05a32e726
doc/opam-repository/OpamHg/B/index.html
Module OpamHg.BSource
val pull_url :
?full_fetch:bool ->
?cache_dir:OpamTypes.dirname ->
?subpath:OpamTypes.subpath ->
OpamTypes.dirname ->
OpamHash.t option ->
OpamTypes.url ->
OpamTypes.filename option OpamTypes.download OpamProcess.jobpull_url ?full_fetch ?cache_dir ?subpath local_dir checksum remote_url pulls the contents of remote_url into local_dir.
Two kinds of results are allowed:
- a single file was downloaded, in this case it is placed within
local_dirand returned asSome filename
- a directory was retrieved, in this case the contents of
local_dirhave been synchronised with its own, andNoneis returned
checksum can be used for retrieval but is NOT checked by this function.
If full_fetch is set to false, VCS repository is retrieved with shallow history (by default, full history). If cache_dir is given, the directory is used by VCS tool as a its cache directory. If subpath is given, only that subpath of the url is retrieved.
val fetch_repo_update :
OpamTypes.repository_name ->
?cache_dir:OpamTypes.dirname ->
OpamTypes.dirname ->
OpamTypes.url ->
OpamRepositoryBackend.update OpamProcess.jobfetch_repo_update fetches the remote update from url to the local repository at dirname, but does not apply it, allowing for further verifications. The file or directory returned is always temporary and should be cleaned up by the caller.
repo_update_complete dirname url finalizes the update of the repository after verification of the patch returned from fetch_repo_update with Update_patch file is applied. Version control systems, e.g. Mercurial, that track the state of the working directory automatically use this to update internal caches.
Return the (optional) revision of a given repository. Only useful for VCS backends. Is not expected to work with fetch_repo_update, which doesn't update the VCS commit information.
val sync_dirty :
?subpath:OpamTypes.subpath ->
OpamTypes.dirname ->
OpamTypes.url ->
OpamTypes.filename option OpamTypes.download OpamProcess.jobval get_remote_url :
?hash:string ->
OpamTypes.dirname ->
OpamTypes.url option OpamProcess.jobget_remote_url ?hash dirname return the distant url of repo dirname, \ if found. When hash is specified, it checks that this hash (branch or \ commit) is present in the distant repository and returns the url with \ this hash. If the hash is absent it returns the remote url with no hash.