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@disroot.org>
-
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=6a69d82228899f73c5e3c04a3fb590f3
sha512=b7899244ab620213f2997409c9d8ac63e1a7ba99ff36abdd0acf41ae545ca7e0534e5e2f6c01a9700c10abf2df4f07944cc64fb5dd315a566f6c5b6b19464729
doc/opam-repository/OpamLocal/B/index.html
Module OpamLocal.B
Source
val pull_url :
?cache_dir:OpamTypes.dirname ->
?subpath:OpamTypes.subpath ->
OpamTypes.dirname ->
OpamHash.t option ->
OpamTypes.url ->
OpamTypes.filename option OpamTypes.download OpamProcess.job
pull_url 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_dir
and returned asSome filename
- a directory was retrieved, in this case the contents of
local_dir
have been synchronised with its own, andNone
is returned
checksum
can be used for retrieval but is NOT checked by this function.
val fetch_repo_update :
OpamTypes.repository_name ->
?cache_dir:OpamTypes.dirname ->
OpamTypes.dirname ->
OpamTypes.url ->
OpamRepositoryBackend.update OpamProcess.job
pull_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 pull_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 pull_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.job
Like pull_url
, except for locally-bound version control backends, where it should get the latest, uncommitted source. First, it performs a pull_url
, then remove deleted files, and finally copy via rsync unversioned & modified-uncommitted files.
val get_remote_url :
?hash:string ->
OpamTypes.dirname ->
OpamTypes.url option OpamProcess.job
get_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.