package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module gives access to the same version/build information returned by Command-based executables when called with the -version or -build-info flags by $0 version (-build-info | -version) or $0 (-build-info | -version).

Here's how it works: we arrange for the build system to, at link time, include an object file that defines symbols that version_util.ml uses to get the strings that contain the information that this module provides. When building with OMake, our OMakeroot runs build_info.sh to generate *.build_info.c with the symbols and that is linked in.

val version_list : string list

All hg repos and their revision.

val version : string

Like version_list but space separated. Consider using version_list instead.

module Version : sig ... end
val arg_spec : (string * Core.Arg.spec * string) list
module Application_specific_fields : sig ... end

Application_specific_fields is a single field in the build-info sexp that holds a Sexp.t String.Map.t, which can be chosen by the application to hold custom fields that it needs.

val build_info : string

Various additional information about the circumstances of the build: who built it, when, on what machine, etc. build_info is the information as it was generated by the build system. reprint_build_info parses and prints the string back, which alters a bit the layout and order of the fields but more importantly allows to display times in the current zone.

val build_info_as_sexp : Core.Sexp.t
val reprint_build_info : (Core.Time_float.t -> Core.Sexp.t) -> string
val username : string option
val hostname : string option
val kernel : string option
val build_time : Core.Time_float.t option
val x_library_inlining : bool
val dynlinkable_code : bool
val compiled_for_speed : bool
val application_specific_fields : Application_specific_fields.t option
val ocaml_version : string
val allowed_projections : string list option
val executable_path : string

Relative to OMakeroot dir

val build_system : string
val with_fdo : (string * Core.Md5.t option) option
module For_tests : sig ... end
val build_system_supports_version_util : bool

If false, all the variables above are filled in with bogus values. The value is false in tests at the moment.

module Expert : sig ... end

When you read the words "version util" below, try adding the word "info" to them: "version util info" makes a little more sense.

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