OpamRepositoryBackend (opam-repository.OpamRepositoryBackend)

type update =

| Update_full of OpamRepositoryRoot.t
(*
No previous known state, the full contents have been put in the given directory
*)
| Update_patch of OpamTypes.filename * Patch.t list
(*
A patch file that corresponds to the update, i.e. applying it to the local repository with 'patch -p1' would get it to the upstream state, and its and its list of file-level operations
*)
| Update_empty
(*
The repository is already up to date
*)
| Update_err of exn
(*
Failed to obtain the update
*)

Type returned by repository updates.

module type S = sig ... end

Backend signature

val to_string : OpamTypes.repository -> string

Pretty-print

val to_json : OpamTypes.repository -> OpamTypes.json

val compare : OpamTypes.repository -> OpamTypes.repository -> int

Compare repositories

val check_digest : OpamTypes.filename -> OpamHash.t option -> bool

check_digest file expected check that the file digest is the one expected.

val job_text : 
  OpamTypes.repository_name ->
  string ->
  'a OpamProcess.job ->
  'a OpamProcess.job

Adds a label to the given job, for the corresponding repository name and action

val get_diff : 
  OpamRepositoryRoot.t ->
  OpamRepositoryRoot.t ->
  (OpamTypes.filename * Patch.t list) option

get_diff dir1 dir2 computes the diff between the two repository root (directory or tar gz archive), returns None if they are equal, and the corresponding patch and the list of file-changes otherwise.

raises Stdlib.Failure
if an unsupported file type or comparison is detected in any of subdir1 or subdir2. Unsupported file types: symlinks, character devices, block devices, named pipes, sockets. Unsupported comparison: comparison between regular files and directories.