package irmin

  1. Overview
  2. Docs
On This Page
  1. Info Functions
package irmin
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Make.InfoSource

Sourcetype author = string
Sourceval author_t : author Irmin.Type.t
Sourcetype message = string
Sourceval message_t : message Irmin.Type.t
Sourcetype t = info

The type for commit info.

Sourceval v : ?author:author -> ?message:message -> int64 -> t

Create a new commit info.

Sourceval date : t -> int64

date t is t's commit date.

The date provided by the user when calling the v function. Rounding Unix.gettimeofday () (when available) is a good value for such date. On more esoteric platforms, any monotonic counter is a fine value as well. On the Git backend, the date is translated into the commit Date field and is expected to be the number of POSIX seconds (thus not counting leap seconds) since the Epoch.

Sourceval author : t -> author

author t is t's commit author.

The author identifies the entity (human, unikernel, process, thread, etc) performing an operation. For the Git backend, this will be directly translated into the Author field.

Sourceval message : t -> message

message t is t's commit message.

Sourceval empty : t

The empty commit info.

Info Functions

Sourcetype f = unit -> t

Alias for functions which can build commit info.

Sourceval none : f

The empty info function. none () is empty

Sourceval pp : t Fmt.t

pp is a pretty-printer for info.

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