package opam-repository

You can search for identifiers within the package.

in-package search v0.2.0

Repository library for opam 2.6

Install

dune-project

Dependency

opam.ocaml.org Readme Edit opam file Versions (39)

Authors

Maintainers

O

opam-devel@lists.ocaml.org

Sources

2.6.0.tar.gz

md5=33de6843fe6e44bf715623fe5fa42d32

sha512=512fc80cf12d277c226bbeed14ce4aeef7ec4aeaa970e76dddf9fb763b310b0209284fd6c83773b3fa63e42c7f09ddf6e3c6b84a0db2de6cc9e58a933124f2b3

doc/opam-repository/OpamRepositoryBackend/index.html

Module `OpamRepositoryBackend`Source

Signature for repository handlers and some helpers for the repository type

Sourcetype 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.

Sourcemodule type S = sig ... end

Backend signature

Sourceval to_string : OpamTypes.repository -> string

Pretty-print

Sourceval to_json : OpamTypes.repository -> OpamTypes.json

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

Compare repositories

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

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

Source

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

Source

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.