Module Boot.Env

Rocq runtime enviroment API.

This module provides functions for manipulation of Rocq's runtime enviroment, including the standard directories and support files.

This API is similar in spirit to findlib's or dune-sites API, see their documentation for more information:

It is important that this library has a minimal dependency set.

The Rocq runtime enviroment needs to be properly initialized before use; we detail the rules below. It is recommended that applications requiring multiple accesses to the environment, do initialize it once and keep a ref to it. We don't forbid yet double initialization, (second time is a noop) but we may do so in the future. Rules for "coqlib" are:

  1. coqlibsuffix given in configure
  2. coqlib given in configure

Note that set_coqlib is used by some commands to process the -coqlib option, as of now this sets both coqlib and coqcorelib; this part of the initialization will be eventually moved here.

The error handling policy of this module is simple for now: failing to initialize Rocq's env will produce a fatal error, and the application will exit with code 1. No error handling is thus required on the client yet.

module Path : sig ... end

This API is loosely inspired by Stdune.Path, for now we keep it minimal, but at some point we may extend it.

type t

Rocq runtime enviroment, including location of Rocq's Corelib

type maybe_env =
| Env of t
| Boot
val initialized : unit -> maybe_env option

Returns None if the environment has not been initialized.

val init_with : coqlib:string option -> t

Init, possibly with a user provided coqlib

val maybe_init : warn_ignored_coqlib:(unit -> unit) -> boot:bool -> coqlib:string option -> maybe_env

Init if boot:false, possibly with a user provided coqlib. Incompatible arguments run warn_ignored_coqlib (ie with boot:true and coqlib:Some)

val ignored_coqlib_msg : string

Usual messsage used for warn_ignored_coqlib

val print_queries_maybe_init : warn_ignored_coqlib:(unit -> unit) -> boot:bool -> coqlib:string option -> Usage.specific_usage option -> Usage.query list -> (maybe_env, string) Stdlib.result

If the query list is empty, behave as maybe_init. Otherwise, print the queries.

If the usage argument is None, the queries must not be PrintHelp.

If a query needs an environment, boot must not be true. If there are queries and none need an environment, returns Ok Boot even if boot was false.

val corelib : t -> Path.t

Corelib directory

val plugins : t -> Path.t

plugins directory

val user_contrib : t -> Path.t

user contrib directory

val tool : t -> string -> Path.t

tool-specific directory

val native_cmi : t -> string -> Path.t

.cmi files needed for native compilation

val revision : t -> Path.t

The location of the revision file

val runtimelib : t -> Path.t

rocq-runtime/lib directory, not sure if to keep this

val coqlib : t -> Path.t

coq/lib directory, not sure if to keep this

val ocamlfind : unit -> string

camlfind () is the path to the ocamlfind binary.

val print_config : ?prefix_var_name:string -> t -> Stdlib.out_channel -> unit
val relocate : Coq_config.relocatable_path -> string
val rocqbin : string