package irmin

  1. Overview
  2. Docs
On This Page
  1. Branches
Legend:
Library
Module
Module type
Parameter
Class
Class type

User-defined branches.

Branches

module type S = sig ... end

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

module String : S with type t = string

String is an implementation of S where branches are strings. The main branch is "main". Valid branch names contain only alpha-numeric characters, -, _, ., and /.

module type Store = sig ... end

Store specifies the signature for branch stores.