diff --git a/doc/index.html b/doc/index.html
index 53ad841..c4853a9 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,7 +2,7 @@
index
- Configure_options (ocaml-version.Ocaml_version.Configure_options) Up – ocaml-version » Ocaml_version » Configure_optionstype o = [ | `Afl | `Default_unsafe_string | `Disable_flat_float_array | `Domains | `Effects | `Flambda | `Force_safe_string | `Frame_pointer | `Multicore | `Multicore_no_effect_syntax | `No_naked_pointers | `No_naked_pointers_checker ] Configuration options available at compiler build time.
val to_string : o -> to_string o returns a compact representation of o
val of_string : string -> o optionof_string s will parse the output of to_stringoNone if the string input is unknown.
val of_t : t -> (o list[> `Msg of string ] ) Stdlib .resultof_t t will parse the extra field of t and return a list of configure options that it represents. Unknown options in the extra field will result in an Error being returned.
val to_t : t -> o list-> t to_t t ol will replace the extra field of t with the list of options represented in ol.
val to_description : o -> to_description o returns a human-readable representation of o
to_configure_flag o returns a string that can be passed to OCaml's configure script to activate that feature.
val compare : t -> o -> o -> compare t a b will return -1 if a is < b, 0 if they are equal, or 1 if a > b. For backwards compatibility reasons, Frame_pointer always comes first in comparisons before OCaml 4.12.0, and is lexically ordered after 4.12.0. The t argument will determine which comparison function to use.
val equal : t -> o -> o -> equal t a b will return true if a=b for a given OCaml version t.
val is_multicore : t -> is_multicore t is true if this version is a multicore-capable release.
Configure_options (ocaml-version.Ocaml_version.Configure_options) Up – ocaml-version » Ocaml_version » Configure_optionstype o = [ | `Afl | `Default_unsafe_string | `Disable_flat_float_array | `Domains | `Effects | `Flambda | `Force_safe_string | `Frame_pointer | `Multicore | `Multicore_no_effect_syntax | `No_naked_pointers | `No_naked_pointers_checker ] Configuration options available at compiler build time.
val to_string : o -> to_string o returns a compact representation of o
val of_string : string -> o optionof_string s will parse the output of to_stringoNone if the string input is unknown.
val of_t : t -> (o list[> `Msg of string ] ) Stdlib .resultof_t t will parse the extra field of t and return a list of configure options that it represents. Unknown options in the extra field will result in an Error being returned.
val to_t : t -> o list-> t to_t t ol will replace the extra field of t with the list of options represented in ol.
val to_description : o -> to_description o returns a human-readable representation of o
to_configure_flag o returns a string that can be passed to OCaml's configure script to activate that feature.
val compare : t -> o -> o -> compare t a b will return -1 if a is < b, 0 if they are equal, or 1 if a > b. For backwards compatibility reasons, Frame_pointer always comes first in comparisons before OCaml 4.12.0, and is lexically ordered after 4.12.0. The t argument will determine which comparison function to use.
val equal : t -> o -> o -> equal t a b will return true if a=b for a given OCaml version t.
val is_multicore : t -> is_multicore t is true if this version is a multicore-capable release.
Has (ocaml-version.Ocaml_version.Has) Up – ocaml-version » Ocaml_version » Hasbytes t will return true if that release has a bytesbytes compatibility package for older releases.
val arch : arch -> t -> arch a t will return true if architecture a is supported on release t.
val options_packages : t -> options_packages t will return true if the release t uses ocaml-option-* packages in opam-repository, rather than +variant packages
val multicore : t -> multicore t will return true if the release t has a multicore OCaml fork available for it. This requires the https://github.com/ocaml-multicore/multicore-opam opam switch to be added before the package is available.
Note that the multicore variants changed between 4.10 and 4.12, and this function returns true for any of them.
Has (ocaml-version.Ocaml_version.Has) Up – ocaml-version » Ocaml_version » Hasbytes t will return true if that release has a bytesbytes compatibility package for older releases.
val arch : arch -> t -> arch a t will return true if architecture a is supported on release t.
val options_packages : t -> options_packages t will return true if the release t uses ocaml-option-* packages in opam-repository, rather than +variant packages
val multicore : t -> multicore t will return true if the release t has a multicore OCaml fork available for it. This requires the https://github.com/ocaml-multicore/multicore-opam opam switch to be added before the package is available.
Note that the multicore variants changed between 4.10 and 4.12, and this function returns true for any of them.
V2 (ocaml-version.Ocaml_version.Opam.V2) Up – ocaml-version » Ocaml_version » Opam » V2Module Opam.V2 Opam 2.0 functions
val package : t -> package t returns the (name, version) pair corresponding to the opam2 package for that compiler version.
val additional_packages : t -> string list additional_packages t returns the list of opam packages which need to be installed in addition to the packaget.
name t returns the opam2 package for that compiler version.
variant_switch t cs returns an OCaml version t whose variant version field reflects the configuration options in cs
val switches : arch -> t -> t listswitches arch t returns the list of opam switches that are available for that compiler and architecture combination. For example, an x86_64 one would yield a list that includes flambda and the flambda-with-frame-pointer combinations.
V2 (ocaml-version.Ocaml_version.Opam.V2) Up – ocaml-version » Ocaml_version » Opam » V2Module Opam.V2 Opam 2.0 functions
val package : t -> package t returns the (name, version) pair corresponding to the opam2 package for that compiler version.
val additional_packages : t -> string list additional_packages t returns the list of opam packages which need to be installed in addition to the packaget.
name t returns the opam2 package for that compiler version.
variant_switch t cs returns an OCaml version t whose variant version field reflects the configuration options in cs
val switches : arch -> t -> t listswitches arch t returns the list of opam switches that are available for that compiler and architecture combination. For example, an x86_64 one would yield a list that includes flambda and the flambda-with-frame-pointer combinations.
Opam (ocaml-version.Ocaml_version.Opam) Up – ocaml-version » Ocaml_version » OpamOpam (ocaml-version.Ocaml_version.Opam) Up – ocaml-version » Ocaml_version » OpamReleases (ocaml-version.Ocaml_version.Releases) Up – ocaml-version » Ocaml_version » ReleasesLatest release in the 3.07 series
Latest release in the 3.08.x series
Latest release in the 3.09.x series
Latest release in the 3.10.x series
Latest release in the 3.11.x series
Latest release in the 3.12.x series
Latest release in the 4.00.x series
Latest release in the 4.01.x series
Latest release in the 4.02.x series
Latest release in the 4.03.x series
Latest release in the 4.04.x series
Latest release in the 4.05.x series
Latest release in the 4.06.x series
Latest release in the 4.07.x series
Latest release in the 4.08.x series
Latest release in the 4.09.x series
Latest release in the 4.10.x series
Latest release in the 4.11.x series
Latest release in the 4.12.x series
Latest release in the 4.13.x series
Latest release in the 4.14.x series
Latest release in the 5.0.x series
Latest release in the 5.1.x series
Latest release in the 5.2.x series
all_patches is an enumeration of all OCaml releases, including every patch release. To get the major and minor releases with the latest patch version, use all
all is an enumeration of all the OCaml releases, with the latest patch versions in each major and minor release.
val unreleased_betas : t listEnumerates the latest beta / release-candidate versions for each unreleased minor OCaml series.
Enumeration of the latest development OCaml releases. This is usually just one, but may include two active dev versions if a release branch has just been cut.
latest is the most recent stable release of OCaml.
recent are the stable OCaml releases since 4.02, with each at the latest patch level. This is the set that is most reliably tested in the opam package repository.
val recent_with_dev : t listrecent_with_dev are the OCaml releases since 4.02 and the latest development branches.
trunk is the version of the trunk branch in the OCaml repository.
is_dev t will return true if the release t represents a development release instead of a stable archive.
Releases (ocaml-version.Ocaml_version.Releases) Up – ocaml-version » Ocaml_version » ReleasesLatest release in the 3.07 series
Latest release in the 3.08.x series
Latest release in the 3.09.x series
Latest release in the 3.10.x series
Latest release in the 3.11.x series
Latest release in the 3.12.x series
Latest release in the 4.00.x series
Latest release in the 4.01.x series
Latest release in the 4.02.x series
Latest release in the 4.03.x series
Latest release in the 4.04.x series
Latest release in the 4.05.x series
Latest release in the 4.06.x series
Latest release in the 4.07.x series
Latest release in the 4.08.x series
Latest release in the 4.09.x series
Latest release in the 4.10.x series
Latest release in the 4.11.x series
Latest release in the 4.12.x series
Latest release in the 4.13.x series
Latest release in the 4.14.x series
Latest release in the 5.0.x series
Latest release in the 5.1.x series
Latest release in the 5.2.x series
all_patches is an enumeration of all OCaml releases, including every patch release. To get the major and minor releases with the latest patch version, use all
all is an enumeration of all the OCaml releases, with the latest patch versions in each major and minor release.
val unreleased_betas : t listEnumerates the latest beta / release-candidate versions for each unreleased minor OCaml series.
Enumeration of the latest development OCaml releases. This is usually just one, but may include two active dev versions if a release branch has just been cut.
latest is the most recent stable release of OCaml.
recent are the stable OCaml releases since 4.02, with each at the latest patch level. This is the set that is most reliably tested in the opam package repository.
val recent_with_dev : t listrecent_with_dev are the OCaml releases since 4.02 and the latest development branches.
trunk is the version of the trunk branch in the OCaml repository.
is_dev t will return true if the release t represents a development release instead of a stable archive.
Since (ocaml-version.Ocaml_version.Since) Up – ocaml-version » Ocaml_version » Sincebytes is the release that the Bytes module first appeared in.
arch a will return the first release of OCaml that the architecture was reasonably stably supported on.
options_packages t will return the first release of OCaml that uses ocaml-option-* packages in opam-repository, rather than +variant packages
Since (ocaml-version.Ocaml_version.Since) Up – ocaml-version » Ocaml_version » Sincebytes is the release that the Bytes module first appeared in.
arch a will return the first release of OCaml that the architecture was reasonably stably supported on.
options_packages t will return the first release of OCaml that uses ocaml-option-* packages in opam-repository, rather than +variant packages
Sources (ocaml-version.Ocaml_version.Sources) Up – ocaml-version » Ocaml_version » Sourcestrunk is the version of the development head of the OCaml git repository.
val git_tag : t -> Sources (ocaml-version.Ocaml_version.Sources) Up – ocaml-version » Ocaml_version » Sourcestrunk is the version of the development head of the OCaml git repository.
val git_tag : t -> Ocaml_version (ocaml-version.Ocaml_version) Up – ocaml-version » Ocaml_versionModule Ocaml_version Manipulate, parse and generate OCaml version strings.
These are of the form major.minor.patch+extra, where the patch and extra fields are optional.
Type of an OCaml version string
val v : ?patch:int -> ?prerelease:string -> ?extra:string -> int -> int -> t v ?patch ?prerelease ?extra major minor will construct an OCaml version string with the appropriate parameters. The patch, prerelease, and extra indicators are optional, but it is conventional to include a patch value of 0 for most recent OCaml releases.
val to_string : ?prerelease_sep:char -> ?sep:char -> t -> to_string ?sep t will convert the version t into a human-readable representation. The sep will default to the normal representation of extra version strings:
~ for prerelease version+ otherwise This can be changed to another character by supplying sep and potentially prerelease_sep. If sep is defined but not prerelease_sep, the prerelease separator is represented by two sep characters. One such use case is to generate Docker container tags from OCaml version strings, where only dashes and alphanumeric characters are allowed.val of_string : string -> (t , [> `Msg of string ] ) Stdlib .resultof_string t will parse the version string in t. The return value is compatible with the Result combinators defined in the rresult library.
val of_string_exn : string -> t of_string_exn t behaves as of_stringInvalid_argument if the string cannot be parsed.
val equal : t -> t -> equal a b is the equality function for two OCaml version strings. Returns true if they are equal, false if they are not.
val compare : t -> t -> compare a b is the comparison function for two OCaml version strings. Returns -1 if a<b, 0 if they are equal and 1 if a>b. Comparison is done using integer comparison for the major, minor and patch versions, and lexical comparison for any extra version strings present.
val pp : Stdlib .Format.formatter -> t -> pp fmt t will output a human-readable version string of t to the fmt formatter.
These definitions cover the CPU architectures that OCaml runs and is supported on.
type arch = [ | `I386 | `X86_64 | `Aarch64 | `Aarch32 | `Ppc64le | `S390x | `Riscv64 ] Type of CPU architectures. This is currently an incomplete list, and lists just those used by the opam test systems. Contributions welcome to complete it.
arches is an enumeration of all of the possible arch
val string_of_arch : arch -> string_of_arch arch will convert arch into a human-readable CPU architecture string. The result will follow the GOARCH convention used by Golang.
val arch_of_string : string -> (arch , [> `Msg of string ] ) Stdlib .resultarch_of_string t will parse the architecture string in t. The return value is compatible with the Result combinators defined in the rresult library. This function is liberal and will attempt to understand variants of the same architecture. For example, both aarch64 and arm64 are parsed into Aarch64.
val arch_of_string_exn : string -> arch arch_of_string_exn t is the same as arch_of_stringInvalid_argument in case of error.
val arch_is_32bit : arch -> arch_is_32bit t will return true if the architecture has a 32-bit wordsize.
val to_opam_arch : arch -> to_opam_arch arch will return a string that is compatible with opam's %{arch}% variable.
val of_opam_arch : string -> arch optionof_opam_arch s will try to convert s that represents an opam %{arch}% variable to an arch
val to_docker_arch : arch -> to_docker_arch arch will return a string that is compatible with a Docker multiarch property. This can be used in --platform flags to docker run, for example.
val of_docker_arch : string -> arch optionof_docker_arch s will try to convert s that represents a Docker multiarch variable to an arch
major t will return the major version number of an OCaml release. For example, of_string "4.03.0" |> major will return 4.
minor t will return the minor version number of an OCaml release. For example, of_string "4.03.0" |> minor will return 3.
val patch : t -> int option patch t will return the patch version number of an OCaml release. For example, of_string "4.03.0" |> minor will return Some 0.
val prerelease : t -> string option prerelease t will return the prerelease extra string of an OCaml prerelease. For example, of_string "4.12.0~beta+flambda" |> prerelease will return Some "beta".
extra t will return the additional information string of an OCaml release. For example, of_string "4.03.0+flambda" |> extra will return Some "flambda".
val with_variant : t -> string option -> t with_variant t extra will return a fresh value with the extra version information in t to extra, and remove it if None is supplied.
val without_variant : t -> t without_variant t is with_variantt None. It removes any extra version information from the version string t.
val with_patch : t -> int option -> t with_patch t patch will return a fresh value with the patch number in t to patch, and remove it if None is supplied.
val without_patch : t -> t without_patch t is as with_patcht None. It removes the least significant number from the version string. This is useful for the Docker OCaml containers, which are all named without a patch number and compiled using the latest patch release (e.g. 4.06 instead of 4.06.1).
val with_just_major_and_minor : t -> t with_just_major_and_minor t strips out any patch and extra version information to return the X.Y form of the OCaml release. For example, 4.08.0+trunk+flambda will return the version representing 4.08.
sys_version is the version of OCaml that this library is currently compiled with, which will be the same as Sys.ocaml_version.
Values representing official releases of OCaml.
Values relating to the source code and version control of OCaml
module Since : sig ... end Determine which release a feature or architecture first appeared in.
Test whether a release has a given feature.
Configuration parameters that affect the behaviour of OCaml at compiler-build-time.
val compiler_variants : arch -> t -> t listcompiler_variants v returns a list of configuration options that are available and useful for version v of the compiler.
val trunk_variants : arch -> t listtrunk_variants v returns a list of OCaml version configurations that should be working and tested on the trunk version of the compiler.
module Opam : sig ... end Opam compiler switches. These are available from the public opam-repository .
Ocaml_version (ocaml-version.Ocaml_version) Up – ocaml-version » Ocaml_versionModule Ocaml_version Manipulate, parse and generate OCaml version strings.
These are of the form major.minor.patch+extra, where the patch and extra fields are optional.
Type of an OCaml version string
val v : ?patch :int -> ?prerelease :string -> ?extra :string -> int -> int -> t v ?patch ?prerelease ?extra major minor will construct an OCaml version string with the appropriate parameters. The patch, prerelease, and extra indicators are optional, but it is conventional to include a patch value of 0 for most recent OCaml releases.
val to_string : ?prerelease_sep :char -> ?sep :char -> t -> to_string ?sep t will convert the version t into a human-readable representation. The sep will default to the normal representation of extra version strings:
~ for prerelease version+ otherwise This can be changed to another character by supplying sep and potentially prerelease_sep. If sep is defined but not prerelease_sep, the prerelease separator is represented by two sep characters. One such use case is to generate Docker container tags from OCaml version strings, where only dashes and alphanumeric characters are allowed.val of_string : string -> (t , [> `Msg of string ] ) Stdlib .resultof_string t will parse the version string in t. The return value is compatible with the Result combinators defined in the rresult library.
val of_string_exn : string -> t of_string_exn t behaves as of_stringInvalid_argument if the string cannot be parsed.
val equal : t -> t -> equal a b is the equality function for two OCaml version strings. Returns true if they are equal, false if they are not.
val compare : t -> t -> compare a b is the comparison function for two OCaml version strings. Returns -1 if a<b, 0 if they are equal and 1 if a>b. Comparison is done using integer comparison for the major, minor and patch versions, and lexical comparison for any extra version strings present.
val pp : Stdlib .Format.formatter -> t -> pp fmt t will output a human-readable version string of t to the fmt formatter.
These definitions cover the CPU architectures that OCaml runs and is supported on.
type arch = [ | `I386 | `X86_64 | `Aarch64 | `Aarch32 | `Ppc64le | `S390x | `Riscv64 ] Type of CPU architectures. This is currently an incomplete list, and lists just those used by the opam test systems. Contributions welcome to complete it.
arches is an enumeration of all of the possible arch
val string_of_arch : arch -> string_of_arch arch will convert arch into a human-readable CPU architecture string. The result will follow the GOARCH convention used by Golang.
val arch_of_string : string -> (arch , [> `Msg of string ] ) Stdlib .resultarch_of_string t will parse the architecture string in t. The return value is compatible with the Result combinators defined in the rresult library. This function is liberal and will attempt to understand variants of the same architecture. For example, both aarch64 and arm64 are parsed into Aarch64.
val arch_of_string_exn : string -> arch arch_of_string_exn t is the same as arch_of_stringInvalid_argument in case of error.
val arch_is_32bit : arch -> arch_is_32bit t will return true if the architecture has a 32-bit wordsize.
val to_opam_arch : arch -> to_opam_arch arch will return a string that is compatible with opam's %{arch}% variable.
val of_opam_arch : string -> arch optionof_opam_arch s will try to convert s that represents an opam %{arch}% variable to an arch
val to_docker_arch : arch -> to_docker_arch arch will return a string that is compatible with a Docker multiarch property. This can be used in --platform flags to docker run, for example.
val of_docker_arch : string -> arch optionof_docker_arch s will try to convert s that represents a Docker multiarch variable to an arch
major t will return the major version number of an OCaml release. For example, of_string "4.03.0" |> major will return 4.
minor t will return the minor version number of an OCaml release. For example, of_string "4.03.0" |> minor will return 3.
val patch : t -> int option patch t will return the patch version number of an OCaml release. For example, of_string "4.03.0" |> minor will return Some 0.
val prerelease : t -> string option prerelease t will return the prerelease extra string of an OCaml prerelease. For example, of_string "4.12.0~beta+flambda" |> prerelease will return Some "beta".
extra t will return the additional information string of an OCaml release. For example, of_string "4.03.0+flambda" |> extra will return Some "flambda".
val with_variant : t -> string option -> t with_variant t extra will return a fresh value with the extra version information in t to extra, and remove it if None is supplied.
val without_variant : t -> t without_variant t is with_variantt None. It removes any extra version information from the version string t.
val with_patch : t -> int option -> t with_patch t patch will return a fresh value with the patch number in t to patch, and remove it if None is supplied.
val without_patch : t -> t without_patch t is as with_patcht None. It removes the least significant number from the version string. This is useful for the Docker OCaml containers, which are all named without a patch number and compiled using the latest patch release (e.g. 4.06 instead of 4.06.1).
val with_just_major_and_minor : t -> t with_just_major_and_minor t strips out any patch and extra version information to return the X.Y form of the OCaml release. For example, 4.08.0+trunk+flambda will return the version representing 4.08.
sys_version is the version of OCaml that this library is currently compiled with, which will be the same as Sys.ocaml_version.
Values representing official releases of OCaml.
Values relating to the source code and version control of OCaml
module Since : sig ... end Determine which release a feature or architecture first appeared in.
Test whether a release has a given feature.
Configuration parameters that affect the behaviour of OCaml at compiler-build-time.
val compiler_variants : arch -> t -> t listcompiler_variants v returns a list of configuration options that are available and useful for version v of the compiler.
val trunk_variants : arch -> t listtrunk_variants v returns a list of OCaml version configurations that should be working and tested on the trunk version of the compiler.
module Opam : sig ... end Opam compiler switches. These are available from the public opam-repository .
index (ocaml-version.index) Up – ocaml-versionThe entry point of this library is the module: Ocaml_version
index (ocaml-version.index) Up – ocaml-versionThe entry point of this library is the module: Ocaml_version