Module Make.CommitSource

Commit defines immutable objects to describe store updates.

Sourcetype t = commit

The type for store commits.

t is the value type for t.

Sourceval pp_hash : t Fmt.t

pp is the pretty-printer for commit. Display only the hash.

Sourceval v : repo -> info:info -> parents:commit_key list -> tree -> commit Lwt.t

v r i ~parents:p t is the commit c such that:

  • info c = i
  • parents c = p
  • tree c = t
Sourceval tree : commit -> tree

tree c is c's root tree.

Sourceval parents : commit -> commit_key list

parents c are c's parents.

Sourceval info : commit -> info

info c is c's info.

Sourceval hash : commit -> hash

hash c is c's hash.

Import/Export

key c is c's key.

Sourceval of_key : repo -> commit_key -> commit option Lwt.t

of_key r k is the the commit object in r with key k, or None if no such commit object exists.

Sourceval of_hash : repo -> hash -> commit option Lwt.t

of_hash r h is the commit object in r with hash h, or None if no such commit object is indexed in r.

Note: in stores for which commit_key = hash, this function has identical behaviour to of_key.