package irmin-git

  1. Overview
  2. Docs
Module type
Class type

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

module type S = sig ... end
type 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

val t : t Irmin.Type.t
val main : t

The name of the main branch.

val is_valid : t -> bool

Check if the branch is valid.

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