On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package opam-repository
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Operations on repositories (update, fetch...) based on the different backends implemented in separate modules
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 possible prefix)
Repository backends
val init :
OpamTypes.dirname ->
OpamTypes.repository_name ->
unit OpamProcess.jobInitialize $opam/repo/$repo
val update : OpamTypes.repository -> unit OpamProcess.jobUpdate $opam/repo/$repo. Raises Failure in case the update couldn't be achieved.
val pull_tree :
string ->
?cache_dir:OpamTypes.dirname ->
?cache_urls:OpamTypes.url list ->
?working_dir:bool ->
OpamTypes.dirname ->
OpamHash.t list ->
OpamTypes.url list ->
unit OpamTypes.download OpamProcess.jobFetch an URL and put the resulting tree into the supplied directory. The URL must either point to a tree (VCS, rsync) or to a known archive type. In case of an archive, the cache 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.
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.jobSame as pull_url, 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 ->
unit OpamTypes.download OpamProcess.jobSame as pull_file, but without a destination file: just ensures the file is present in the cache.
val revision :
OpamTypes.dirname ->
OpamTypes.url ->
OpamTypes.version option OpamProcess.jobGet the optional revision associated to a backend (git hash, etc.).
val current_branch : OpamTypes.url -> string option OpamProcess.jobGet the version-control branch for that url. Only applicable for local, version controlled URLs. Returns None in other cases.
val is_dirty : OpamTypes.url -> bool OpamProcess.jobReturns true if the url points to a local, version-controlled directory that has uncommitted changes
val find_backend : OpamTypes.repository -> (module OpamRepositoryBackend.S)Find a backend
val find_backend_by_kind : OpamUrl.backend -> (module OpamRepositoryBackend.S)On This Page