package core_kernel

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (10)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

core_kernel-v0.16.0.tar.gz
sha256=e37370bad978cfb71fdaf2b1a25ab1506b98ef0b91e0dbd189ffd9d853245ce2

doc/core_kernel.version_util/Version_util/index.html

Module Version_utilSource

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.

Sourceval version_list : string list

All hg repos and their revision.

Sourceval version : string

Like version_list but space separated. Consider using version_list instead.

Sourcemodule Version : sig ... end
Sourceval arg_spec : (string * Core.Arg.spec * string) list

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.

Sourceval 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.

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

Relative to OMakeroot dir

Sourceval build_system : string
Sourceval with_fdo : (string * Core.Md5.t option) option
Sourcemodule For_tests : sig ... end
Sourceval 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.

Sourcemodule 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.