package irmin-git

  1. Overview
  2. Docs
On This Page
  1. Module types
package irmin-git
Legend:
Library
Module
Module type
Parameter
Class
Class type

Git backend

module Metadata : sig ... end
module Conf : sig ... end
module Branch : sig ... end

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

module Reference : sig ... end

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

module Schema : sig ... end

Module types

module type G = sig ... end
module type S = sig ... end

The Git backend specializes a few types:

module type Maker = sig ... end
module type KV_maker = sig ... end
val config : ?head:Git.Reference.t -> ?bare:bool -> ?level:int -> ?dot_git:string -> ?buffers:int -> string -> Irmin.config
type reference = Reference.t
val reference_t : reference Irmin.Type.t
module Content_addressable (G : Git.S) : sig ... end

Use Git as a content-addressable store. Values will be stored into .git/objects.

module Atomic_write (G : Git.S) : sig ... end

Use Git as an atomic-write store. Values will be stored into .git/refs. When using the Git filesystem backend, branch names .

module Maker (G : G) (S : Git.Sync.S with type hash := G.hash and type store := G.t) : Maker with module G := G
module KV (G : G) (S : Git.Sync.S with type hash := G.hash and type store := G.t) : KV_maker with module G := G and type branch = string
module Ref (G : G) (S : Git.Sync.S with type hash := G.hash and type store := G.t) : KV_maker with module G := G and type branch = Reference.t
module Mem : G with type t = Digestif.SHA1.t Git.Mem.t and type hash = Digestif.SHA1.t

In-memory Git store.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct