package irmin

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

The signature for branches. Irmin branches are similar to Git branches: they are used to associated user-defined names to head commits. Branches havve a default value: the master branch.

Signature for Branches

type t

The type for branches.

val t : t Type.t

t is the value type for t.

val pp : t Fmt.t

pp pretty-prints branches.

val of_string : string -> (t, [ `Msg of string ]) Result.result

of_string parses branch names.

val master : t

The name of the master branch.

val is_valid : t -> bool

Check if the branch is valid.

OCaml

Innovation. Community. Security.