package tezos-version

You can search for identifiers within the package.

in-package search v0.2.0

tezos-version
- Tezos_version
tezos-version.parser
- Tezos_version_parser

Legend:
Library
Module
Module type
Parameter
Class
Class type

Version information.

This module provides the current version number.

type additional_info = Tezos_version_parser.additional_info =

| Dev
| RC of int
| RC_dev of int
| Release

Additional version information.

Dev means "Development Version". All non-release branches should use this.

RC means "Release Candidate". For each release, the first release candidate has number 1.

RC_dev means "Release Candidate in development". This is a release branch where the release candidate tag is not associated to the HEAD of the branch.

Release means "no additional information". This is an actual released version. No additional info is printed.

val string_of_additional_info : additional_info -> string

Convert additional version information to a string.

The result is a string of the form "+dev", "~rcX", "~rcX+dev" or "".

type t = Tezos_version_parser.t = {

major : int;
minor : int;
additional_info : additional_info;

}

Version information.

Major versions include significant new features and are usually released in new branches which start from master.

Minor versions include mostly bug fixes and are usually released in branches which start from the previous release. When the major version is incremented, the minor version is reset to 0.

val to_string : t -> string

Convert a version to a string.

Examples:

to_string { major = 7; minor = 0; additional_info = Release } = "7.0"
to_string { major = 7; minor = 0; additional_info = Dev } = "7.0+dev"
to_string { major = 7; minor = 0; additional_info = RC 1 } = "7.0~rc1"
to_string { major = 7; minor = 0; additional_info = RC_dev 1 } = "7.0~rc1+dev"

val pp : Format.formatter -> t -> unit

Version printer.

pp f x prints to_string x in f

val parse_version : string -> t option