package octez-internal-libs

  1. Overview
  2. Docs
A package that contains some libraries used by the Octez suite

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-internal-libs.irmin/Irmin/module-type-S/Info/index.html

Module S.InfoSource

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

The type for commit info.

Sourceval t : t Type.t
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

OCaml

Innovation. Community. Security.