package irmin-git

  1. Overview
  2. Docs
Git backend for Irmin

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.10.0.tbz
sha256=92a9de7a0a2a35c2feba0c35a806b1f0df24c1c0d15164eebf3f919296d26715
sha512=0203ec5117a851ad5afeb2f9091659b4e142e231b6b945caab93f4d7beb23397c8ac43f7056e91d18f4bff0be1062f6ae966d221f877c229328c0cbbf29fd9f0

doc/irmin-git/Irmin_git/Reference/index.html

Module Irmin_git.ReferenceSource

one-to-one mapping between Irmin and Git references.

Sourcemodule type S = sig ... end
Sourcetype t = [
  1. | `Branch of string
  2. | `Remote of string
  3. | `Tag of string
  4. | `Other of string
]

The type for Git references. Use the Branch module to only deal with `Branch values.

include S with type t := t
include Irmin.Branch.S with type t := t

Signature for Branches

Sourceval main : t

The name of the main branch.

Sourceval is_valid : t -> bool

Check if the branch is valid.

Sourceval pp_ref : t Fmt.t
Sourceval of_ref : string -> (t, [ `Msg of string ]) result