package irmin

The type for configuration converter parsers.

The type for configuration converter printers.

The type for configuration converters.

parser c is c's parser.

converter c is c's printer.

The type for configuration keys whose lookup value is 'a.

key ~docs ~docv ~doc name conv default is a configuration key named name that maps to value default by default. conv is used to convert key values provided by end users.

docs is the title of a documentation section under which the key is documented. doc is a short documentation string for the key, this should be a single sentence or paragraph starting with a capital letter and ending with a dot. docv is a meta-variable for representing the values of the key (e.g. "BOOL" for a boolean).

• raises Invalid_argument

  if the key name is not made of a sequence of ASCII lowercase letter, digit, dash or underscore. FIXME not implemented.

  Warning. No two keys should share the same name as this may lead to difficulties in the UI.

The key name.

tc k is k's converter.

default k is k's default value.

doc k is k's documentation string (if any).

docv k is k's value documentation meta-variable (if any).

docs k is k's documentation section (if any).

Default --root=ROOT argument.

The type for configurations.

empty is the empty configuration.

singleton k v is the configuration where k maps to v.

is_empty c is true iff c is empty.

mem c k is true iff k has a mapping in c.

add c k v is c with k mapping to v.

rem c k is c with k unbound.

union r s is the union of the configurations r and s.

find c k is k's mapping in c, if any.

get c k is k's mapping in c.

Raises. Not_found if k is not bound in d.

bool converts values with bool_of_string.

int converts values with int_of_string.

string converts values with the identity function.

uri converts values with Uri.of_string.

string converts values with the identity function.