package octez-internal-libs

  1. Overview
  2. Docs
A package that contains some libraries used by the Octez suite

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (1)

Authors

  1. T
    Tezos devteam
  2. T
    Thomas Gazagnaire
  3. T
    Thomas Leonard
  4. C
    Craig Ferguson

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-internal-libs.irmin/Irmin/Commit/History/index.html

Module Commit.HistorySource

Build a commit history.

Parameters

module C : Store

Signature

Commit History

Sourcetype 'a t = 'a C.t

The type for store handles.

Sourcetype node_key = C.Node.key

The type for node keys.

Sourceval node_key_t : node_key Type.t
Sourcetype commit_key = C.key

The type for commit keys.

Sourceval commit_key_t : commit_key Type.t
Sourcetype v = C.Val.t

The type for commit objects.

Sourceval v_t : v Type.t
Sourcetype info = C.Info.t

The type for commit info.

Sourceval info_t : info Type.t
Sourceval v : [> Perms.write ] t -> node:node_key -> parents:commit_key list -> info:info -> (commit_key * v) Lwt.t

Create a new commit.

Sourceval parents : [> Perms.read ] t -> commit_key -> commit_key list Lwt.t

Get the commit parents.

Commits form a append-only, fully functional, partial-order data-structure: every commit carries the list of its immediate predecessors.

Sourceval merge : [> Perms.read_write ] t -> info:(unit -> info) -> commit_key Merge.t

merge t is the 3-way merge function for commit.

Sourceval lcas : [> Perms.read ] t -> ?max_depth:int -> ?n:int -> commit_key -> commit_key -> (commit_key list, [ `Max_depth_reached | `Too_many_lcas ]) result Lwt.t

Find the lowest common ancestors lca between two commits.

Sourceval lca : [> Perms.read_write ] t -> info:(unit -> info) -> ?max_depth:int -> ?n:int -> commit_key list -> (commit_key option, Merge.conflict) result Lwt.t

Compute the lowest common ancestors ancestor of a list of commits by recursively calling lcas and merging the results.

If one of the merges results in a conflict, or if a call to lcas returns either Error `Max_depth_reached or Error `Too_many_lcas then the function returns the same error.

Sourceval three_way_merge : [> Perms.read_write ] t -> info:(unit -> info) -> ?max_depth:int -> ?n:int -> commit_key -> commit_key -> (commit_key, Merge.conflict) result Lwt.t

Compute the lcas of the two commit and 3-way merge the result.

Sourceval closure : [> Perms.read ] t -> min:commit_key list -> max:commit_key list -> commit_key list Lwt.t

Same as Node.Graph.closure but for the history graph.

Sourceval iter : [> Perms.read ] t -> min:commit_key list -> max:commit_key list -> ?commit:(commit_key -> unit Lwt.t) -> ?edge:(commit_key -> commit_key -> unit Lwt.t) -> ?skip:(commit_key -> bool Lwt.t) -> ?rev:bool -> unit -> unit Lwt.t

Same as Node.Graph.iter but for traversing the history graph.