package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=535254ca443858bfc9e540535977fed63e9206d4b78c5cac0239d1e6657b5c78
sha512=fa18557fcf808121a0495de707c6f7bff4a69197b310480816648adafd4a659b5673a1f5bbf4574f517b7d93253735ef7798b0c365d87afac60675007ef19b54
doc/irmin-pack.mem/Irmin_pack_mem/Maker/Make/Head/index.html
Module Make.Head
Managing the store's heads.
list t
is the list of all the heads in local store. Similar to git rev-list --all
.
find t
is the current head of the store t
. This works for both persistent and temporary branches. In the case of a persistent branch, this involves getting the the head associated with the branch, so this may block. In the case of a temporary store, it simply returns the current head. Returns None
if the store has no contents. Similar to git rev-parse HEAD
.
Same as find
but raise Invalid_argument
if the store does not have any contents.
set t h
updates t
's contents with the contents of the commit h
. Can cause data loss as it discards the current contents. Similar to git reset --hard <hash>
.
fast_forward t h
is similar to set
but the t
's head is updated to h
only if h
is stricly in the future of t
's current head. max_depth
or n
are used to limit the search space of the lowest common ancestors (see lcas
).
The result is:
Ok ()
if the operation is succesfull;Error `No_change
ifh
is alreadyt
's head;Error `Rejected
ifh
is not in the strict future oft
's head.Error e
if the history exploration has been cut before getting useful results. In that case. the operation can be retried using different parameters ofn
andmax_depth
to get better results.
val merge :
into:t ->
info:Info.f ->
?max_depth:int ->
?n:int ->
commit ->
(unit, Irmin__.Merge.conflict) result Lwt.t
merge ~into:t ?max_head ?n commit
merges the contents of the commit associated to commit
into t
. max_depth
is the maximal depth used for getting the lowest common ancestor. n
is the maximum number of lowest common ancestors. If present, max_depth
or n
are used to limit the search space of the lowest common ancestors (see lcas
).