A tool is specified either by name, to be looked up via an unspecified mecanism, or by a file path to an executable file. It also declares the environment variables it accesses in the process environment and whether and how it supports response files.
Declared environment variables are split into relevant and shielded variables. A relevant variable is a variable whose value influences the tool's output. A shielded variable is a variable whose value does not influence the tool's output but is nonetheless essential to its operation. Shielded environment variables do not appear in the spawn environment signature which is used to memoize tool spawns. Variables specifying the location of temporary file directories are good examples of shielded variables.
Portability. In order to maximize portability no
suffix should be added to executable names on Windows, the
search procedure will add the suffix during the tool search
procedure if absent.
val tmp_vars :
["TMPDIR"; "TEMP"; "TMP"].
val response_file_of :
(B0_std.Cmd.t -> string) ->
(B0_std.Fpath.t -> B0_std.Cmd.t) -> response_file
response_file_of to_file cliis a response file specification that uses
to_file cmdto convert the command line
cmdto a response file content and
cli fa command line fragment to be given to the tool so that it treats file
fas a response file.
val args0 :
args0is response file support for tools that reads null byte (
0x00) terminated arguments response files via an
-args0 FILEcommand line synopsis.
val v :
?vars:env_vars -> B0_std.Cmd.tool -> t
v ~response_file ~shielded_vars ~vars cmdis a tool specified by
varsare the relevant variables accessed by the tool (defaults to
shielded_varsare the shielded variables accessed by the tool (defaults to
response_filedefines the reponse file support for the tool (if any).
val by_name :
?vars:env_vars -> string -> t
B00.Tool.vbut reference the tool directly via a name.
val name :
t -> B0_std.Cmd.tool
t's tool name. If this is a relative file path with a single segment the tool is meant to be searched via an external mecanism.
val vars :
t -> env_vars
vars tare the relevant environment variables accessed by
val shielded_vars :
t -> env_vars
shieled_vars tare the shielded environment variables accessed by
val response_file :
t -> response_file option
t's response file specification (if any).
val read_env :
t -> B0_std.Os.Env.t -> B0_std.Os.Env.t * B0_std.Os.Env.t
read_env t envis (all, relevant) with
allthe environment with the variables of
envthat are in