Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package opam-repository
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Each backend should implement this signature.
val name : OpamUrl.backendval exists : OpamTypes.dirname -> boolTest whether the given repository is correctly initialized.
val init : OpamTypes.dirname -> OpamTypes.url -> unit OpamProcess.jobInit a repository.
val fetch :
?cache_dir:OpamTypes.dirname ->
OpamTypes.dirname ->
OpamTypes.url ->
unit OpamProcess.jobFetch changes from upstream. This is supposed to put the changes in a staging area. Be aware that the remote URL might have been changed, so make sure to update accordingly.
val reset : OpamTypes.dirname -> OpamTypes.url -> unit OpamProcess.jobReset the master branch of the repository to match the remote repository state. This might still fetch more data (git submodules...), so is unsuitable for running after validation.
val diff :
OpamTypes.dirname ->
OpamTypes.url ->
OpamTypes.filename option OpamProcess.jobReturns the pending modifications in the form of a patch file, or None if dirname is up to date with what was last fetched.
val is_up_to_date : OpamTypes.dirname -> OpamTypes.url -> bool OpamProcess.jobReturns true if the last fetched state is equal to the current, on-disk state
val revision : OpamTypes.dirname -> string option OpamProcess.jobReturns an backend-specific identifier for the current revision.
val versionned_files : OpamTypes.dirname -> string list OpamProcess.jobReturns the list of files under version control
val vc_dir : OpamTypes.dirname -> OpamTypes.dirnameReturns the absolute directory name for vc data (e.g. .../project/.git)
val current_branch : OpamTypes.dirname -> string option OpamProcess.jobReturns the currently selected branch handle. It should be valid as the hash field of OpamUrl.t.
val is_dirty : OpamTypes.dirname -> bool OpamProcess.jobReturns true if the working tree state is different from the state recorded in the VCS as current. This differs from is_up_to_date, which compares specifically to the last fetched state. This should always be false after reset has been called.