Index of values


(%%) [B0.Cmd]
l %% frag appends the line fragment frag to l.
(%) [B0.Cmd]
l % arg adds arg to the command line l.
(+) [B0.Fpath]
p + ext is add_ext p ext.
(++) [B0_json.G]
s ++ s' is sequence s' concatenated to s.
(-+) [B0.Fpath]
p -+ ext is set_ext p ext.
(/) [B0.Fpath]
p / seg is add_seg p seg.
(//) [B0.Fpath]
p // p' is append p p'.
(>>=) [B0]
r >>= f is f v if r = Ok v and r otherwise.
(>>|) [B0]
r >>| f is f >>= fun v -> Ok (f v).

A
abs_diff [B0.Time]
abs_diff s0 s1 is the aboslute difference between s0 and s1.
add [B0.Conf.Preset]
add p c is (c', errs) where c' is c with the bindings of p added.
add [B0.Meta.Fpath.Map]
add p k v m adds key k with value v to p's metadata in m.
add [B0.Time]
add s0 s1 is s0 + s1.
add [B0.Hmap.MAP]
add k v m is m with k bound to v.
add_arg [B0.Cmd]
add_arg l arg is l % arg.
add_args [B0.Cmd]
add_args l frag is l %% frag.
add_ext [B0.Fpath]
add_ext ext p is p with ext concatenated to p's basename.
add_path_meta [B0.Build]
add_path_meta ~force b f k v sets f's meta binding for k to v.
add_seg [B0.Fpath]
add_seg p seg if p's last segment is non-empty this is p with seg added.
add_tag [B0.Hmap.MAP]
add_tag k m is add k true m.
aim [B0.Outcome.Op]
aim o is the build target for which the operation was submitted.
any_binding [B0.Hmap.MAP]
any_binding m is a binding of m (if not empty).
app [B0.Log]
app is msg App.
append [B0.Fpath]
append p q appends q to p as follows: q is absolute or has a non-empty volume then q is returned., Otherwise appends q's segment to p using B0.Fpath.add_seg.
arch [B0_care.OS]
arch is the architecture of the operating system.
arch_bits [B0_care.OS]
arch_bits is number of bits in a word on the architecture of the operating system, derived from B0_care.OS.arch.
archive [B0_ocaml.Build]
arr [B0_json.G]
arr els is a generated array whose values are generated by the elements els.
array [B0_json.Q]
array q queries the elements of a JSON array with q.
array [B0.Fmt]
array ~sep pp_v formats array elements.
asm_ext [B0_c]
asm_ext is the file extension for assembly files.
assets_url [B0_github.Release]
assets_url t is the issue's assets url.
assignments [B0.OS.Env]
assignements () is the current process environments as a list of strings of the form "var=value".
atom_key [B0.Sexp]
atom_key is like B0.Sexp.key but requires and parses an atom.
atom_list_key [B0.Sexp]
atom_list is like B0.Sexp.list_key but parses a list of atoms.
auth [B0_github]
auth ~user () determines a personal access token for user user.
await_units [B0.Build]
await_units b us k waits for the build of us to be finished before proceeding with k us.

B
b0_dir [B0_driver.Cli]
b0_dir specifies the b0 directory to use.
b0_dir [B0_driver.Driver]
b0_dir is the absolute path to the b0 directory.
basename [B0.Unit]
basename u is u's given base name, without the namespacing.
basename [B0.Pkg]
basename u is u's given base name, without the namespacing.
basename [B0.Fpath]
basename p is the last non-empty segment of p or the empty string otherwise.
basename_equal [B0.Fpath]
basename p0 p1 is String.equal (filename p0) (basename p1).
bench [B0_care.Unit]
bench is for units with benchmarking outcomes.
body [B0_github.Release]
body r is the description of the release.
body [B0_github.Issue]
body t is the issue's body.
bool [B0_json.G]
bool b is b as a generated JSON boolean value.
bool [B0_json.Q]
bool queries a boolean JSON value.
bool [B0.Conv]
bool is a converter for booleans.
bool [B0.Fmt]
bool is Format.pp_print_bool.
box [B0.Fmt]
box ~indent pp ppf wraps pp in a horizontal or vertical box.
braces [B0.Fmt]
braces pp_v ppf is pf "@[<1>{%a}@]" pp_v.
brackets [B0.Fmt]
brackets pp_v ppf is pf "@[<1>[%a]@]" pp_v.
buffer_add [B0_json.G]
buffer_add b g adds the generated JSON value g to b.
build [B0_care.Unit]
build is for units with outcomes used by the build system itself.
build_byte [B0_ocaml.Conf]
build_byte c is true if byte code artefacts should be produced.
build_byte [B0_ocaml.Key]
build_byte is true if byte code artefacts should be produced.
build_cmtis [B0_ocaml.Conf]
build_cmtis c is true if cmti artefacts should be produced.
build_cmtis [B0_ocaml.Key]
build_cmtis is true if cmti artefacts should be produced.
build_dir [B0.Build]
build_dir b is the path to b's current, unit-specific, build directory.
build_file [B0.Build]
build_file b f is Fpath.(build_dir b / f).
build_native [B0_ocaml.Conf]
build_native c is true if native code artefacts should be produced.
build_native [B0_ocaml.Key]
build_native is true if native code artefacts should be produced.
build_native_dynlink [B0_ocaml.Conf]
build_native_dynlink c is true if native dynlink artefacts should be produced.
build_native_dynlink [B0_ocaml.Key]
build_native_dynlink is true if native dynlink artefacts should be produced.
build_path [B0.Variant]
build_path v is the path to v's build directory.
built_files [B0.Outcome]
built_files o is the of files that are written in o.
byte_compiler [B0_ocaml.Conf]
byte_compiler c args is a tool run for the OCaml byte code compiler.
byte_ext [B0_ocaml.Conf]
byte_ext c is the file extension for OCaml byte code executables.

C
cache [B0.Build]
cache_dir [B0_driver.Cli]
cache_index [B0_driver.Cli]
cache_index_path [B0.Variant]
cache_index_path v is the path to v's cache index.
cached [B0.Outcome.Op]
cached o is true iff status o = Cached.
cap [B0.Tty]
cap kind determines capabilities according to kind.
cardinal [B0.Hmap.MAP]
cardinal m is the number of bindings in m.
cdll_ext [B0_ocaml.Conf]
clib_ext c is the file extension for C dynamic libraries.
char [B0.Conv]
char is a convert for a single character.
char [B0.Fmt]
char is Format.pp_print_char.
clib_ext [B0_ocaml.Conf]
clib_ext c is the file extension for C static libraries.
close [B0_github.Issue]
close auth repo n closes issues n on the repository repo
cmas [B0_ocaml.Lib]
cmas s is the ordered set of cma files needed to byte link against the library set.
cmd [B0_opam]
cmd opam is opam's command.
cmd [B0_docker]
cmd d is d's docker command.
cmd [B0.Conv]
cmd is a converter for a command line parsed using B0.Cmd.of_string.
cmi_compiler [B0_ocaml.Conf]
cmi_compiler c args is a tool run for the compiler responsible for compiling cmi files.
cmxa_clibs [B0_ocaml.Lib]
cmxa_clibs s is the ordered set of C archives associated to cmxas needed to native link against the library set.
cmxas [B0_ocaml.Lib]
cmxas s is the ordered set of cmxa files needed to native link against the library set.
cobj_ext [B0_ocaml.Conf]
cobj_ext c is the file extension for C object files.
codec [B0.Conv]
codec (decode, encode) is a codec using decode to decode values from byte strings and encode to encode values to byte strings.
collect [B0.OS.Cmd]
collect ~block pid tries to collect the exit status of spawn pid.
color [B0_driver.Cli]
color specifies the end-user output mode.
color [B0_driver.Driver]
color s is the requested terminal capability.
comma [B0.Fmt]
comma is unit ",@ ".
common_man [B0_driver.Cli]
common_man is a manual that should be included in any driver command.
compare [B0.Variant]
equal v0 v1 is a total order on variants compatible with B0.Variant.equal.
compare [B0.Outcome.Op]
compare o0 o1 is a total order on operation compatible with B0.Outcome.Op.equal.
compare [B0.Hash]
compare h0 h1 is a total order on hashes compatible with B0.Hash.equal.
compare [B0.Def.S]
compare v0 v1 is a total order on values compatible with B0.Def.S.equal.
compare [B0.Def.Loc]
compare l0 l1 totally orders l0 and l1.
compare [B0.Cmd]
compare l l' is a total order on command lines.
compare [B0.Fpath]
compare p0 p1 is a total order on paths compatible with B0.Fpath.equal.
compare_by_name [B0.Variant]
compare v0 v1 totally orders v0 and v1 in increasing lexicographical variant name order.
compare_by_name [B0.Def.S]
compare_by_name v0 v1 totally orders v0 and v1 by name in increasing lexicographical order.
compare_exec_start_time [B0.Outcome.Op]
compare o0 o1 is a total order on operations according to their B0.Outcome.Op.exec_start_time.
compare_span [B0.Time]
compare_span s0 s1 orders span by increasing duration.
compile [B0_ocaml.Build]
conf [B0_ocaml]
ctx b is an OCaml configuration derived from the build configuration.
conf [B0.Outcome]
conf o is the effective configuration used by the build.
conf [B0.Build]
conf b k is k's effective value for the build.
conf_path [B0.Variant]
conf_path v is the path to v's configuration.
conf_tool [B0.Build]
conf_tool b k is tool b (conf b k).
const [B0.Conf.Preset]
const is B0.Conf.const.
const [B0.Conf]
const v is the value v.
container_create [B0_docker]
container_create d ~workdir ~binds i c creates a container c in detached mode with image i runs.
container_delete [B0_docker]
container_delete d c force deletes container c.
container_exec [B0_docker]
container_exec d c cmd runs cmd in container c.
container_exists [B0_docker]
container_exists d c is true iff container c exists.
contents [B0.OS.Dir]
contents ~dotfiles ~rel dir is the list of directories and files in dir.
conv [B0.Hmap.KEY]
conv k is k's converter.
copy_file [B0.Build]
copy_file ?linenum src dst, copies src to dst.
copy_file_dst [B0.Outcome.Op]
copy_file_dst c is c's destination file.
copy_file_linenum [B0.Outcome.Op]
copy_file_linenum c is c's line number directive value (if any).
copy_file_result [B0.Outcome.Op]
copy_file_result c is c's result.
copy_file_src [B0.Outcome.Op]
copy_file_src c is c's source file.
count [B0.Time]
count c is the monotonic time span elapsed since c was created.
counter [B0.Time]
counter () is a counter counting from now on.
cpu_children_stime_s [B0.Time]
cpu_utime_s cpu is cpu's system time in seconds for children processes.
cpu_children_utime_s [B0.Time]
cpu_utime_s cpu is cpu's user time in seconds for children processes.
cpu_count [B0.Time]
cpu_count c are CPU times since c was created.
cpu_counter [B0.Time]
cpu_counter () is a counter counting from now on.
cpu_dur [B0.Build]
cpu_dur d is the current cpu duration.
cpu_stime_s [B0.Time]
cpu_stime_s cpu is cpu's system time in seconds.
cpu_utime_s [B0.Time]
cpu_utime_s cpu is cpu's user time in seconds.
cpu_zero [B0.Time]
cpu_zero is zero CPU times.
create [B0_github.Release]
create auth repo ~tag_name ~body () creates a new release in repository repo with given tag_name and body description.
create [B0_github.Issue]
create auth repo opens an issue on the repository repo with the given title and body.
create [B0_driver.Driver]
create ~name ~version ~libs cmds main is a driver named name versioned with version that implements its service using the libraries libs sorted in dependency order (recursive dependencies are not looked up) and the given cmds.
create [B0.Variant]
create ~preset ~dir n scheme creates a variant named n with scheme scheme in directory dir and if preset is true (default) applies the scheme's preset on the empty configuration.
create [B0.Build]
init cache ctrl ~dir initializes a new build using dir as the build directory.
create [B0.Unit]
create ~doc n b is a build unit with unique name n build function b and documented by doc and which logs B0.Unit.doc_outcome once built.
create [B0.Pkg]
create ~doc n b is a package with name n documented by doc.
create [B0.OS.Dir]
create ~path ~mode dir creates, if needed, the directory dir with file permission mode (defaults 0o755 readable and traversable by everyone, writeable by the user).
creation_time [B0.Outcome.Op]
creation_time o is o's monotonic creation time.
ctrl [B0_driver.Cli]
ctrl has options control the build.
ctrl [B0.Build]
ctrl ~max_spawn controls a build as follows: max_spawn is the maximal number of commands that are spawned concurrently. Defaults to 1., tty_cap is the capabilities of the output terminal. Defaults to Tty.None.
current [B0.OS.Dir]
current () is the current working directory.
current [B0.OS.Env]
current () is the current process environment.
cut [B0.String]
cut ~sep s is either the pair Some (l,r) of the two (possibly empty) substrings of s that are delimited by the first match of the separator character sep or None if sep can't be matched in s.
cut [B0.Fmt]
cut is Format.pp_print_cut.
cuts [B0.String]
cuts sep s is the list of all substrings of s that are delimited by matches of the non empty separator string sep.
cwd [B0_driver.Cli]
cwd specifies a directory to immedialy change to before interpreting anything in the program.
cycle [B0.Outcome.Op]
cycle o0 o1 is Some (r0, r1) with r0 a file read by o0 and written by o1 and r1 a file read by o1 and written by o0 or None if there no such two files.

D
dash [B0.OS.File]
dash is "-".
debug [B0.Log]
debug is msg Debug.
decode [B0.Hmap.MAP]
decode bs is a map and a list of errors resulting from decoding the encoded binding list l.
decode [B0.Conv]
decode c is c's binary decoder.
def [B0.Conf.Preset]
def k d is a preset element that sets k to definition d.
def [B0.Def.S_DEF]
def ~loc ~doc n is a definition named n at location loc with documentation string doc (defaults to "Undocumented.").
def_add [B0.Def.S_DEF]
def_add v adds v's definition to the underlying index.
def_binding [B0.Conf.Preset]
def_binding d is d's key-value binding.
def_doc [B0.Conf.Preset]
def_doc d is d's documentation string.
def_get [B0.Def.DEFINED]
def_get v is v's definition.
def_key [B0.Conf.Preset]
def_key d is d's key.
def_kind [B0.Def.DEFINED]
def_kind is an uncapitalized string used in user interface to stand for the kind of defined values.
def_name_tty_color [B0.Def.DEFINED]
def_name_tty_color is a tty color to render the value's names.
def_namespaced [B0.Def.DEFINED]
def_namespaced is true iff definition names are namespaced.
def_pp_info [B0.Def.DEFINED]
def_pp_info ppf v is the value field printing function use to derive B0.Def.S.pp_info.
def_rem [B0.Def.S_DEF]
def_rem v removes v's definition from the underlying index.
default [B0.Conf.Key]
default k is k's default value.
default_cache_dir [B0_driver.Cli]
TODO get rid of this.
default_tmp [B0.OS.Dir]
default_tmp () is a default directory that can be used as a default directory for creating temporary files and directories.
default_variant_name [B0_driver.B0_dir]
default_variant_name d is d's default variant name (if any).
default_variant_scheme_name [B0_driver.B0_dir]
default_variant_scheme_name d is d's default variant scheme name (if any).
defs [B0.Conf.Preset]
defs p are p's key-value definitions, sorted by key name.
delete [B0.Variant]
delete ~force v deletes variant v.
delete [B0.OS.Dir]
delete ~must_exist ~contents dir deletes the directory dir.
delete [B0.OS.File]
delete ~must_exist file deletes file file.
delete_file [B0.Outcome.Op]
delete_file d is d's deleted file.
delete_result [B0.Outcome.Op]
delete_result d is d's result.
dev [B0_care.Unit]
dev is for units with outcomes used during development.
dir [B0_driver.B0_dir]
dir d is d's directory.
dir [B0.Build]
dir b is the absolute path to b's build directory.
dir [B0.Cache]
dir c is c's directory.
dir [B0.Conv]
dir is a converter for directories.
dir_sep [B0.Fpath]
dir_sep is B0.Fpath.dir_sep_char as a string.
dir_sep_char [B0.Fpath]
dir_sep_char is the platform dependent natural directory separator.
direct [B0.Variant.Scheme]
direct ~preset ~setup ~build ~stage ~delete () is direct variant which applies preset preset to the empty configuration on variant creation, uses setup to setup the variant, build before and after building in the variant, stage before and after executing a program in the variant's deployments install environment post_build after building in the variant, and delete when the variant is deleted.
direct_env [B0.Variant.Scheme]
direct_env d is d's build environment setup function.
direct_preset [B0.Variant.Scheme]
direct_preset d is d's direct preset.
dirs [B0.OS.Dir]
dirs is like B0.OS.Dir.contents but only returns directories.
discover [B0.Conf.Preset]
discover is B0.Conf.discover.
discover [B0.Conf]
discover ~store f is the value f k c with c the configuration in which the value must be defined and k the actual key.
dist [B0_care]
dist indicates that a built file generated in the hierarchy rooted at B0.build.src_dir should be kept for distribution.
distribution [B0_care.OS]
distribution is the operating system distribution or a package manager.
dll_ext [B0_c]
dll_ext is the file extension for C dynamic libraries.
doc [B0_care.Unit]
doc is for units with documentation outcomes.
doc [B0.Def.S]
doc v is v's documentation string.
doc_outcome [B0.Unit]
doc_outcome u is a string logged when the unit builds successfully.
docv [B0.Conv]
docv c is c 's documentation meta-variable.
dom [B0.Outcome.Op.Map]
dom [B0.Unit.Map]
dom m is the domain of m.
dom [B0.Pkg.Map]
dom m is the domain of m.
dom [B0.Fpath.Map]
dom m is the domain of m.
dom [B0.String.Map]
dom m is the domain of m.
driver_compile [B0_driver.Cli]
driver_compile are options to be added to the driver instance compilation command.
driver_compile_kind [B0_driver.Cli]
driver_compile_kind is an option to specify which kind of compilation should be used for compiling the instance.
driver_default_exits [B0_driver.Cli]
driver_default_exits describe the above errors to Cmdliner.
driver_dir [B0_driver.Cli]
driver_dir is an option to specify the directory in which driver instances should be built.
driver_force [B0_driver.Cli]
driver_force is an option to specify that the driver instance should be recompiled unconditionaly.
driver_link [B0_driver.Cli]
driver_link are options to be added to the driver link command.
driver_main [B0_driver.Driver]
driver_main () runs the driver executable's main function.
driver_ocamlc [B0_driver.Cli]
driver_ocamlc is the executable to use as the OCaml byte-code compiler for the instance.
driver_ocamlopt [B0_driver.Cli]
driver_ocamlopt is the executable to use as the OCaml native-code compiler for the instance.
driver_only [B0_driver.Cli]
driver_only is an option to specify that only the driver instance should be built and the program should stop.
driver_trust [B0_driver.Cli]
driver_trust is an option to specify that the driver instance should be trusted to be up-to-date.
drop [B0.String]
drop ~sat s is snd (span ~sat s).
drop_initial_v [B0.String]
drop_initial_v s drops a leading 'v' or 'V' from s.
dump [B0.Cmd]
dump ppf l dumps and unspecified representation of l on ppf.
dump [B0.Fpath.Map]
dump pp_v ppf m prints an unspecified representation of m on ppf using pp_v to print the map codomain elements.
dump [B0.Fpath.Set]
dump ppf ss prints an unspecified representation of ss on ppf.
dump [B0.Fpath]
dump ppf p prints path p on ppf using B0.String.dump.
dump [B0.String.Map]
dump pp_v ppf m prints an unspecified representation of m on ppf using pp_v to print the map codomain elements.
dump [B0.String.Set]
dump ppf ss prints an unspecified representation of ss on ppf.
dump [B0.String]
dump ppf s prints s as a syntactically valid OCaml string on ppf.
dump_locs [B0.Sexp]
dump_locs ppf se dumps the location of the s-expressions se on ppf.
dump_string_map [B0.String.Map]
dump_string_map ppf m prints an unspecified representation of the string map m on ppf.

E
edit_distance [B0.String]
edit_distance s0 s1 is the number of single character edits (insertion, deletion, substitution) that are needed to change s0 into s1.
el [B0_json.G]
el v is v as a generated JSON array element.
el_if [B0_json.G]
el_if c v is el (v ()) if c is true and B0_json.G.empty otherwise.
empty [B0_ocaml.Lib]
The empty library set.
empty [B0_json.G]
An empty sequence.
empty [B0.Cache]
empty ~index_file ~dir is an empty cache with index index and directory dir.
empty [B0.Meta.Fpath.Map]
empty is the empty map.
empty [B0.OS.Env]
empty is String.Map.empty.
empty [B0.Hmap.MAP]
empty is the empty map.
empty [B0.Cmd]
empty is an empty command line.
encode [B0.Hmap.MAP]
encode m is (l,errs) with l the bindings of m whose encoding suceeded and errs the bindings of m whose encoding failed.
encode [B0.Conv]
encode c is c's binary encoder.
enum [B0.Conv]
enum ~docv alts derives a converter from the association list alts.
env [B0_opam]
env opam ~switch is the environment for the opam switch switch.
env [B0.Build]
env b is b's environment.
env [B0.Env]
env e aim is e's consulted process environment for tools runs which aim at producing artefacts for aim.
env_tool_lookup [B0.Env]
env_tool_lookup ~sep ~var env is a tool lookup that gets the value of the var variable (defaults to PATH) in env and performs a POSIX PATH variable search.
env_vars [B0_ocaml.Tool]
Environment variables that influence the OCaml toolchain outputs.
equal [B0.Variant]
equal v0 v1 is true iff v0 and v1 are the same variant.
equal [B0.Outcome.Op]
equal o0 o1 is true iff o0 and o1 are the same operation.
equal [B0.Hash]
equal h0 h1 is true iff h0 and h1 are equal.
equal [B0.Def.S]
equal v0 v1 is true iff v0 and v1 and have the same name.
equal [B0.Def.Loc]
equal l0 l1 is true iff l0 and l1 are the same location.
equal [B0.Cmd]
equal l l' is true iff l and l' are litterally equal.
equal [B0.Fpath]
equal p0 p1 is true iff p0 and p1 are stringwise equal.
err [B0.Log]
err is msg Error.
err_count [B0.Log]
err_count () is the number of messages logged with level Error.
error_msg [B0.R]
error_msg s is Error (`Msg s).
error_msgf [B0.R]
error_msgf fmt ... is an error formatted according to fmt.
exe [B0_ocaml.Unit]
exe is an executable named name.
exe [B0_ocaml.Build]
exe b c srcs name produces an executable with base name name by compiling and linking srcs along with libs.
exe [B0_care.Unit]
exe is for units with executable outcomes.
exe [B0_care]
exe indicates the file is executable.
exe_ext [B0_ocaml.Conf]
exe_ext c is the operating system extensions for file executables.
exe_ext [B0_care.OS]
exe_ext is the file extension used for executable file formats on the operating system.
exe_meta [B0_ocaml.Unit]
exe_meta is the default metadata for B0_ocaml.Unit.exe.
exec [B0_driver.Driver]
exec is the kind of execution.
exec_end_time [B0.Outcome.Op]
exec_end_time o is o's monotonic time when the operation's has been processed by the operating system.
exec_start_time [B0.Outcome.Op]
exec_start_time o is o's monotonic operating system starting execution time.
execv [B0.OS.Cmd]
execv ~env ~cwd f argv executes file f as a new process in environment env with args as the Sys.argv of this process (in particular Sys.argv.(0) is the name of the program not the first argument to the program).
exists [B0_driver.B0_dir]
exists d is true iff (dir d) exists.
exists [B0.Variant]
exists ~dir n is Ok true if variant named n exists in dir.
exists [B0.Cache]
exists ~index_file ~dir is true if index_file exists.
exists [B0.OS.Cmd]
exists ~search cmd is Ok true if B0.OS.Cmd.find_tool finds a path and Ok false if it does not.
exists [B0.OS.Dir]
exists dir is true if dir is a directory in the file system and false otherwise.
exists [B0.OS.File]
exists file is true if file is a regular in the file system and false otherwise.
exists [B0.Hmap.MAP]
exists p m is true iff there exists a bindings of m that satisfies p.
exists [B0.String]
exists p s is true iff there exists an index i of s with p s.[i] = true.
exit_driver_setup_err [B0_driver.Cli]
exit code when driver setup errors.
exit_no_description [B0_driver.Cli]
exit code when no description is found.
exit_some_error [B0_driver.Cli]
exit code when some undiscriminate error reported on stdout occurs.
exn [B0.Fmt]
exn formats an exception.
exn_backtrace [B0.Fmt]
exn_backtrace formats an exception backtrace.

F
fail [B0.Build]
fail (fun m -> m fmt ...) fails the current build unit with the formatted message m.
fail_on_error_msg [B0.Build]
fail_on_error_msg r is: v, if r is Ok v., fail (fun m -> m "%s" e), if r is Error (`Msg e).
failwith_error_msg [B0.R]
failwith_error_msg r raises Failure m if r is Error (`Msg m)
family [B0_care.OS]
family is the operating system family.
fd [B0.Hash]
fd fd mmaps and hashes the object pointed by fd.
field [B0.Fmt]
field ~style l pp_v pretty prints a named field with label l styled according to style (defaults to [`Fg `Yellow]), using pp_v to print the value.
file [B0.Hash]
file p is the hash of file path p.
file [B0.Def.Loc]
file f locates in f.
file [B0.Conv]
file is a converter for files.
file_kind [B0_driver.Cli]
file_kind specifies the kind of files that need to be looked up.
filename [B0.Fpath]
filename p is the file name of p.
filename_equal [B0.Fpath]
filename_equal p0 p1 is String.equal (filename p0) (filename p1).
files [B0.OS.Dir]
files is like B0.OS.Dir.contents but only returns files.
filter [B0.Hmap.MAP]
filter p m are the bindings of m that satisfy p.
find [B0.Variant]
find ~dir n is the variant named n in directory dir (if any).
find [B0.Meta.Fpath.Map]
find p k m is the value of p's metadata key k in m.
find [B0.OS.Env]
find ~empty_is_absent name is the value of the process environment variable name, if defined.
find [B0.Hmap.MAP]
find k m is the value of k's binding in m, if any.
find [B0.Def.S]
find n is the value named n (if any).
find_def [B0.Conf.Preset]
find_def name finds a definition for a key named name.
find_file [B0.Def.Loc]
find_file l is Some f is l is located in f.
find_path_meta [B0.Build]
find_path_meta b f k is f's meta binding for k in build b (if any).
find_tool [B0.OS.Cmd]
find_tool ~search cmd is the path to the tool of cmd as found by the tool search procedure in search.
finish [B0.Build]
finish b finishes the build b.
finished [B0.Build]
flag [B0.Hmap.MAP]
flag ~absent k m is the value of k in m or absent (defaults to false) if k is not bound in m.
float [B0_json.G]
float f is f as a generated JSON number.
float [B0_json.Q]
float queries a float JSON value.
float [B0.Conv]
float is a converter for floats.
float [B0.Fmt]
float is pf ppf "%g".
fold [B0.Hmap.MAP]
fold f m acc folds over the bindings of m with f, starting with acc
for_all [B0.Hmap.MAP]
for_all p m is true iff all bindings of m satisfy p.
for_all [B0.String]
for_all p s is true iff for all indices i of s, p s.[i] = true.
for_string [B0_json]
for_string s is to_string (`String s).
forced_env [B0.Env]
forced_env e aim is e's forced process environment for tools which aim at producing artefacts for aim.
fpath [B0.Conv]
fpath is a converter for file paths.
fpath_meta [B0.Outcome]
fpath_meta o is the file metadata for the build.
func [B0.Unit]
func u is u's build function.

G
get [B0_opam]
get () looks up an opam binary in the build's program PATH or in the environment variable B0_OPAM if defined.
get [B0_json.Q]
get is the identity function
get [B0_github.Release]
get auth repo ~tag_name () gets the release with given tag_name in repo tag_name.
get [B0_docker]
get () looks up a docker binary in the build's program PATH or in the environment variable B0_DOCKER if defined.
get [B0.Variant]
get ~dir n is like B0.Variant.find but
get [B0.Meta.Fpath.Map]
get p k m is like B0.Meta.Fpath.Map.find but
get [B0.OS.Env]
get ~empty_is_absent name ~absent is the value of the process environment variable environment variable name, if defined, and absent if undefined.
get [B0.Hmap.MAP]
get k m is the value of k's binding in m.
get [B0.Def.S]
get n is like B0.Def.S.find but
get_all [B0.Meta.Fpath.Map]
get_all p m is all the metadata for p in m.
get_any_binding [B0.Hmap.MAP]
get_any_binding m is a binding of m.
get_atom [B0.Sexp]
get_atom s is the atom in s.
get_current [B0.Def.Loc]
get_current () is the current location of definitions.
get_default [B0.Conf]
get_default k c is k's default value in c.
get_effective [B0.Conf]
get_effective env k c gets the effective value of key k in environment env and configuration c.
get_ext [B0.Fpath]
get_ext p is p's basename file extension or the empty string if there is no extension.
get_line_tool [B0.Cmd]
get_line_tool l is like B0.Cmd.line_tool but
get_list [B0.Sexp]
get_list s is the list in s.
get_or_suggest [B0.Variant]
get_or_suggest ~dir n is the variant with name n if it exists or a list of suggested variant names that could match n.
get_or_suggest [B0.Hmap.MAP]
get_or_suggest k m is the value of k's binding in m or, if k is not bound in m it suggests alternative, key names found in m.
get_or_suggest [B0.Def.S]
get_or_suggest n is the value with name n if it exists or a list of suggested values whose name could match n.
get_or_suggest_def [B0.Conf.Preset]
get_or_suggest_def name is the definition for a key named name if it exists or a list of suggested key names that could match name.
get_resolver [B0_ocaml.Lib]
get_resolver b r is the resolver r or a default resolver (potententially looked up in b's config).
get_root [B0.Def.Loc]
get_root () is the current file source root.
get_rsync [B0_ssh]
get_rsync () looks up an rsync binary in the build's program PATH or in the environment variable B0_RSYNC if defined.
get_ssh [B0_ssh]
get_ssh () looks up an ssh binary in the build's program PATH or in the environment variable B0_SSH if defined.
get_sub_root [B0.Def.Loc]
get_sub_root () is the file source sub root.
get_tool [B0.OS.Cmd]
get_tool cmd is like B0.OS.Cmd.find_tool except it errors if the tool path cannot be found.
get_value [B0.OS.Env]
value ~log ~empty_is_absent name conv ~absent is like B0.OS.Env.value except on parse errors, they are logged with level log (if any) and absent is returned.
group [B0.Conf.Key]
group k is k's group.

H
handle_error [B0_driver.Cli]
handle_error (Ok c) is c.
has_ext [B0.Fpath]
has_ext ext p is true iff get_ext p = e || get_ext ~multi:true p = e.
has_tag [B0.Unit]
has_tag k u is true iff k's value in u's meta is true.
has_tag [B0.Pkg]
has_tag k u is true iff k's value in u's meta is true.
hash [B0.Stamp]
hbox [B0.Fmt]
hbox is like B0.Fmt.box but is a horizontal box: the line is not split in this box (but may be in sub-boxes).
head [B0.String]
head s if Some s.[0] if s <> "" and None otherwise.
html_url [B0_github.Release]
html_url t is the issue's HTML url.
hvbox [B0.Fmt]
hvbox is like B0.Fmt.box but is either B0.Fmt.hbox if its fits on a single line or B0.Fmt.vbox otherwise.

I
id [B0_github.Release]
id r is the id of the release.
id [B0.Outcome.Op]
id o is the identifier of operation o.
id [B0.Unit]
id u is u's unique identifier for the program run.
id [B0.Pkg]
id u is u's unique identifier for the program run.
image_build [B0_docker]
build ~opts ~context dockerfile is an image named name build from dockerfile using context (defaults to -) with opts cli arguments added to the docker build command.
image_create [B0_docker]
image_create d i b creates (builds) image i with b.
image_delete [B0_docker]
image_delete d img force deletes image img.
image_exists [B0_docker]
image_exists d img is true iff img exists.
import [B0_jbuilder]
import () lookup for jbuild files in the directory and direct subdirectories of the B0.ml description file that invokes it and represents their stanzas as build units.
import_file [B0_jbuilder]
import_file f represents the stanzas in f as build units.
in_fd [B0.OS.Cmd]
in_fd ~close fd is a standard input that reads from file descriptor fd.
in_file [B0.OS.Cmd]
in_file f is a standard input that reads from file f.
in_null [B0.OS.Cmd]
in_null is in_file File.null.
in_stdin [B0.OS.Cmd]
in_stdin is in_fd ~close:false Unix.stdin, a standard input that reads from the current process standard input.
in_string [B0.OS.Cmd]
in_string s is a standard input that reads the string s.
incs_comp [B0_ocaml.Lib]
incs_comp s is the list of includes needed to compile a source against the set.
incs_link [B0_ocaml.Lib]
incs_link s is the list of includes needed to link an object against the set.
index_file [B0.Cache]
index_file c is c's index file.
info [B0.Hmap.KEY]
info k is k's key information.
info [B0.Log]
info is msg Info.
install [B0_care]
install indicates the file is installable at the given install specification.
instance_main [B0_driver.Driver]
instance_main () runs the driver instance's main function.
int [B0_json.G]
int i is i as a generated JSON number.
int [B0_json.Q]
int queries an float JSON value and truncate's it.
int [B0.Conv]
int is a converter for ints.
int [B0.Fmt]
int is pf ppf "%d".
int32 [B0.Conv]
int32 is a converter for int32.
int64 [B0.Conv]
int64 is a converter for int64.
is_abs [B0.Fpath]
is_abs p is true iff p is an absolute path, i.e.
is_dir_path [B0.Fpath]
is_dir_path p is true iff p syntactically represents a directory.
is_empty [B0_ocaml.Lib]
is_empty s is true iff s is empty.
is_empty [B0.Cache]
is_empty c is true iff c is empty.
is_empty [B0.Hmap.MAP]
is_empty m is true iff m is empty.
is_empty [B0.Cmd]
is_empty l is true iff l is empty.
is_executable [B0.OS.File]
is_executable file is true iff file exists and is executable.
is_file_path [B0.Fpath]
is_file_path p is true iff p syntactically represents a file.
is_none [B0.Def.Loc]
is_none l is true iff l is B0.Def.Loc.none.
is_prefix [B0.String]
is_prefix ~affix s is true iff affix.[i] = s.[i] for all indices i of affix.
is_rel [B0.Fpath]
is_rel p is true iff p is a relative path, i.e.
is_rel_seg [B0.Fpath]
is_rel_seg s is true iff s is a relative segment in other words either "." or "..".
is_root [B0.Fpath]
is_root p is true iff p is a root directory, i.e.
is_seg [B0.Fpath]
is_seg s is true iff s does not contain a B0.Fpath.dir_sep.
is_suffix [B0.String]
is_suffix ~affix s is true iff affix.[n - i] = s.[m - i] for all indices i of affix with n = String.length affix - 1 and m = String.length s - 1.
iter [B0.Hmap.MAP]
iter f m applies f to all bindings of m.
iter [B0.Fmt]
iter ~sep iter pp_elt formats the iterations of iter over a value using pp_elt.
iter_bindings [B0.Fmt]
iter_bindings ~sep iter pp_binding formats the iterations of iter over a value using pp_binding.

J
join [B0.R]
join r is v if r = Ok v and r otherwise.
json [B0_json.Q]
json queries any JSON value.

K
key [B0.Sexp]
key ~absent parse name looks up key name, parse its value according parse (which should raise Failure with an error that includes the location in case of error).
key [B0.Tool]
key ~internal ~env_vars ~tools name is a command line tool and configuration key named name, and that can manifest itself as one of tools (defaults to [Fpath.v name]).
key [B0.Conf]
key n conv ~default ~group ~doc is a configuration key with unique name n whose value is converted using conv.
key_kind [B0.Hmap.KEY_INFO]
key_kind is an uncapitalized string used in user interface to stand for the kind of keys.
key_name_tty_color [B0.Hmap.KEY_INFO]
key_name_tty_color is a tty color to render the key's names.
key_namespaced [B0.Hmap.KEY_INFO]
def_namespaced is true iff key names are namespaced.
keys [B0.Conf.Preset]
keys p are the keys that are preset by p.
keys [B0.Conf.Group]
keys g are the keys that belong to group g.
keys [B0.Conf]
keys c are the keys defined in c.
kind [B0.Variant.Scheme]
kind s is s's scheme kind.
kind [B0.Outcome.Op]
kind o is o's kind.
kind [B0.Tty]
kind out determines the kind of terminal by consulting the TERM environment variable and using Unix.isatty on out's file descriptor.
kind_to_string [B0.Outcome.Op]
kind_to_string k is a string token for k.
kmsg [B0.Log]
kmsg k level m logs m with level level and continues with k.

L
level [B0.Log]
level () is the current reporting level.
level_of_string [B0.Log]
level_of_string s parses a level from s according to the representation of B0.Log.level_to_string.
level_to_string [B0.Log]
level_to_string l converts l to a string representation.
lib [B0_ocaml.Unit]
lib name is a library named name.
lib [B0_ocaml.Build]
libs b c srcs name produces a library with base name base by compiling and srcs against libs.
lib [B0_care.Unit]
lib is for units with library outcomes.
lib [B0.Def.Loc]
lib l locates in library l.
lib_deps [B0_ocaml.Unit]
lib_deps is a list of OCaml libraries names the unit needs to produce its outcomes.
lib_ext [B0_c]
lib_ext is the file extension for C static libraries.
lib_meta [B0_ocaml.Unit]
exe_meta is the default metadata for B0_ocaml.Unit.lib.
lib_name [B0_ocaml.Unit]
lib_name is the name of a library built by the unit.
libs [B0_ocaml.Lib]
libs s is the ordered set of libraries requested in the set with their recursive dependencies.
line_args [B0.Cmd]
line_args is l's command line arguments, the elements of l without the command name.
line_tool [B0.Cmd]
line_tool l is l's first element, usually the executable tool name or file path.
lines [B0.Fmt]
lines formats lines by replacing newlines ('\n') in the string with calls to Format.pp_force_newline.
link [B0_ocaml.Build]
link [B0.OS.File]
link ~force ~target p hard links target to path p.
list [B0_github.Issue]
list auth repo lists the issues for repository repo.
list [B0.Variant]
list ~dir is the list of variants located in directory dir in increasing lexicographical variant name order.
list [B0.Def.S]
list () is the list of existing value lexicographically ordered by increasing value name.
list [B0.Conv]
list ?sep c is a converter for lists of c.
list [B0.Fmt]
list ~sep pp_v formats list elements.
list_empty [B0.Variant]
list_empty ~dir is Ok true if there are no variants dir or if dir doesn't exist.
list_key [B0.Sexp]
list_key is like B0.Sexp.key but requires and parses a list of elements.
load [B0.Cache]
load ~index_file ~dir loads a cache from index_file and dir.
load [B0.Conf]
load file loads a configuration from file.
loc [B0.Def.S]
loc v is v's source.

M
map [B0.String]
map f s is s' with s'.[i] = f s.[i] for all indices i of s.
mapi [B0.String]
mapi f s is s' with s'.[i] = f i s.[i] for all indices i of s.
mem [B0_json.G]
mem name v is a generated object member whose name is name and value is v.
mem [B0_json.Q]
mem name q o queries a JSON object o's member name with q.
mem [B0.Meta.Fpath.Map]
mem p k m is true iff path p has a binding for k in m.
mem [B0.Hmap.MAP]
mem k m is true iff k is bound in m.
mem_ext [B0.Fpath]
mem_ext exts p is List.exists (fun e -> has_ext e p) exts
mem_if [B0_json.G]
mem_if c name v is mem name v if c is true and B0_json.G.empty otherwise.
mem_opt [B0_json.Q]
mem_opt name q queries a JSON object o's optional member name with q.
meta [B0.Unit]
meta u is u's metadata.
meta [B0.Pkg]
meta u is u's metadata.
meta_add [B0.Unit]
meta_add k v u binds k to v in u's meta.
meta_find [B0.Unit]
meta_find k u is k's value in u's meta (if any).
meta_find [B0.Pkg]
meta_find k u is k's value in u's meta (if any).
meta_get [B0.Unit]
meta_get k u is like B0.Unit.meta_find but
meta_get [B0.Pkg]
meta_get k u is like B0.Pkg.meta_find but
meta_mem [B0.Unit]
meta_mem k u is true iff k is defined in u's meta.
meta_mem [B0.Pkg]
meta_mem k u is true iff k is defined in u's meta.
meth_to_string [B0_http]
meth_to_string m is a string representation of m.
mkdir [B0.Build]
mkdir b d k creates dir and proceeds with k.
mkdir_dir [B0.Outcome.Op]
mkdir_dir mk is mk's created directory.
mkdir_result [B0.Outcome.Op]
mkdir_result mk is mk's result.
msg [B0.Log]
See Logs.msg.
msgf [B0.R]
msgf fmt ... is a B0.R.msg formatted according to fmt.
must_exist [B0_driver.B0_dir]
must_exist d is Ok () if (dir d) exists and an error otherwise.
must_exist [B0.OS.Cmd]
must_exist ~search cmd is Ok cmd if B0.OS.Cmd.get_tool succeeds.
must_exist [B0.OS.Dir]
must_exist dir is Ok dir if dir is a directory in the file system and an error otherwise.
must_exist [B0.OS.File]
must_exist file is file if file is a regular file in the file system and an error otherwise.

N
name [B0_github.Repo]
name r is r's name.
name [B0_care.OS]
name is the operating system name.
name [B0.Variant]
name v is v's name.
name [B0.Hash]
name is the name of the hash function.
name [B0.Def.S]
name v is v's name.
native_compiler [B0_ocaml.Conf]
anative_compiler c args is a tool run for the OCaml native code compiler.
native_ext [B0_ocaml.Conf]
native_ext c is the file extension for OCaml native code executables.
no_description_found [B0_driver.Cli]
no_description_found () logs an error that no description was found and returns B0_driver.Cli.exit_no_description.
none [B0.Conf.Group]
none is the group attached to keys that do not specify an explicit group.
none [B0.Def.Loc]
none locates nothing.
none_stub [B0.Fmt]
none_stub is unit "<none>".
nop [B0.Variant.Scheme]
The nop scheme.
nop [B0.Fmt]
nop formats nothing.
null [B0_json.G]
null is the generated JSON null value.
null [B0_json.Q]
null queries a null JSON value.
null [B0.OS.File]
null represents a file on the OS that discards all writes and returns end of file on reads.
nullable [B0_json.Q]
nullable q queries either a null JSON value or with q.
number [B0_github.Issue]
number i is the issue's number.

O
obj [B0_json.G]
obj mems is a generated object whose members are generated by mems.
obj [B0_json.Q]
obj v queries an object and returns v.
obj_ext [B0_c]
ext_obj is the file extension for C object files.
ocamlc [B0_ocaml.Tool]
ocamlc is the OCaml byte-code compiler.
ocamldep [B0_ocaml.Tool]
ocamldep is the OCaml dependency analyzer.
ocamlfind [B0_ocaml.Lib]
ocamlfind is the ocamlfind tool.
ocamlmklib [B0_ocaml.Tool]
ocamlmklib is the OCaml mixed C/OCaml library builder.
ocamlmktop [B0_ocaml.Tool]
ocamlmktop is the OCaml custom toplevel builder.
ocamlopt [B0_ocaml.Tool]
ocamlopt is the OCaml native-code compiler.
of_assignments [B0.OS.Env]
of_assignments ~init ss folds over strings in ss, cuts them at the first '=' character and adds the resulting pair to init (defaults to B0.OS.Env.empty).
of_build [B0.Outcome]
of_build ?prev b is the build outcome of b, prev if specified indicates a previous build outcome.
of_char [B0.String]
of_char c is c as a string.
of_file [B0_jbuilder]
of_file f reads a jbuild file from f.
of_file [B0.Sexp]
of_file f inputs a top-level sequence of s-expressions from s and returns it as a list that spans the whole input.
of_file [B0.Tool]
of_file ~internal ~env_vars file is like B0.Tool.v but if file is: A relative file path with a single segment, the tool is looked up in the build's search path like in B0.Tool.v, Otherwise, the tool is the corresponding file.
of_fpaths [B0.Cmd]
of_fpaths ?slip ps is like B0.Cmd.of_list but acts on a list of paths.
of_hash [B0.Stamp]
of_hex [B0.Hash]
of_hex s parses a sequence of US-ASCII hexadecimal digits from s into a hash.
of_json [B0_json.G]
of_json v is the JSON value v as a generated value.
of_list [B0.Outcome.Op.Map]
of_list [B0.Unit.Map]
of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.
of_list [B0.Pkg.Map]
of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.
of_list [B0.Cmd]
of_list ?slip l is a command line from the list of arguments l.
of_list [B0.Fpath.Map]
of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.
of_list [B0.String.Map]
of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.
of_load [B0.Variant]
of_load l is the variant in l.
of_ocamldep_output [B0_ocaml.Deps]
of_ocamldep_output ~src data f acc parses ocamldep -modules output from data and folds f starting with acc over each file dependencies.
of_preset [B0.Conf]
of_preset p is Preset.add p empty.
of_rev_list [B0.Cmd]
of_rev_list l is a command line from the reversed list of arguments l.
of_string [B0_json]
of_string s parses JSON text from s according to RFC8259 with the following limitations: Numbers are parsed with string_of_float which is not compliant., Unicode escapes are left unparsed (this will not round trip with B0_json.to_string).
of_string [B0.Sexp]
of_string ~src s inputs a top-level sequence of s-expressions from s and returns it as a list that spans the whole input.
of_string [B0.Cmd]
of_string s tokenizes s into a command line.
of_string [B0.Fpath]
of_string s is the string s as a path.
of_typed [B0.Hmap.KEY]
of_typed k is k's existential key.
of_uint64_ns [B0.Time]
of_uint64_ns u is the unsigned 64-bit integer nanosecond span u as a span.
of_unit_file [B0.Tool]
of_unit_file ~internal_env_vars ~env_vars file is like B0.Tool.of_file but the given relative file is located in the build directory of B0.Unit.
of_unknown_scheme [B0.Variant]
of_unknown_scheme u is the variant in u with The nop variant scheme scheme.
of_values [B0.Cmd]
of_values ?slip conv l is like B0.Cmd.of_list but acts on a list of values, each converted to an argument with conv.
on [B0.Cmd]
on bool line is line if bool is true and B0.Cmd.empty otherwise.
on_error [B0.Log]
See Logs.on_error.
on_error_msg [B0.Log]
See Logs.on_error_msg.
one [B0.Time]
one is a span of 1ns.
open_error_msg [B0.R]
open_error_msg r allows to combine a closed error message variant with other variants.
ops [B0.Outcome]
ops o are the build's operations.
ops_to_trace_event_format [B0_extra]
ops_to_json o ops outputs operations ops of outcome o as JSON text in Trace Event Format.
option [B0.Conv]
option c parses a c option using none (defaults to "") to denote None in textual converters.
option [B0.Fmt]
option ~none pp_v formats an optional value.
out_fd [B0.OS.Cmd]
out_fd ~close fd is a standard output that writes to file descriptor fd.
out_file [B0.OS.Cmd]
out_file f is a standard output that writes to file f.
out_fmt [B0_driver.Cli]
out_fmt specifies the amount of information requested.
out_null [B0.OS.Cmd]
out_null is out_file File.null
out_stderr [B0.OS.Cmd]
out_stderr is out_fd ~close:false Unix.stderr
out_stdout [B0.OS.Cmd]
out_stdout is out_fd ~close:false Unix.stdout
outcome_path [B0.Variant]
outcome_path v is the path to v's outcome
output [B0_json.G]
output oc g outputs the generated JSON value g on oc.
override [B0.OS.Env]
override env ~by:o overrides the definitions in env by o.
owner [B0_github.Repo]
owner r is r's owner.

P
p [B0.Cmd]
pair [B0.Conv]
pair ?sep fst snd is a converter for pairs of fst and snd.
pair [B0.Fmt]
pair ~sep pp_fst pp_snd formats a pair.
parens [B0.Fmt]
parens pp_v ppf is pf "@[<1>(%a)@]" pp_v.
parent [B0.Fpath]
parent p is a directory path that contains p.
parse [B0.Conv]
parse c is c's textual parser.
parse_atom [B0.Sexp]
parse_atom key se parses an atom from se assuming this is for a key named key (used for error reporting).
parse_atom_kind [B0.Sexp]
parse_atom_kind parse key se is like B0.Sexp.parse_atom but uses parse to transform the atom.
parse_list [B0.Sexp]
parse_list key se parses a list from se assuming this is for a key named key (used for error reporting).
parse_list_kind [B0.Sexp]
parse_list_kind parse key se is like B0.Sexp.parse_list but uses parse to transform the atom.
parse_version [B0.String]
parse_version parses version strings of the form:
"[v]major.minor[.patchlevel][+additional-info]"
into (major, minor, patch, additional_info) tuples.
path [B0.Variant]
path v is the path to v.
path_arg [B0_driver.Cli]
path_arg is a cmdliner converter for Fpath values.
perform [B0_http]
perform r performs request r via curl which is looked up in the PATH or in the environment variable B0_CURL.
pf [B0.Fmt]
pf is Format.fprintf.
pid_to_int [B0.OS.Cmd]
pid_to_int pid is the system identifier for process identifier pid.
pkg [B0.Unit]
pkg u is u's package (if any).
pp [B0_github.Release]
pp is a formatter for issues.
pp [B0_github.Issue]
pp is a formatter for issues.
pp [B0.Outcome.Op]
pp [B0.Unit.Map]
pp [B0.Unit.Set]
pp [B0.Unit.Idmap]
pp [B0.Unit.Idset]
pp [B0.Pkg.Map]
pp [B0.Pkg.Set]
pp [B0.Pkg.Idmap]
pp [B0.Pkg.Idset]
pp [B0.Hash]
pp ppf h prints an unspecified representation of h on ppf.
pp [B0.Hmap.MAP]
pp [B0.Hmap.KEY_INFO]
pp pp_v ppf i is a printer for key information.
pp [B0.Def.Loc]
pp ppf l prints and unspecified representation of l on ppf.
pp [B0.Cmd]
pp ppf l formats an unspecified representation of l on ppf.
pp [B0.Fpath.Map]
pp ~sep pp_binding ppf m formats the bindings of m on ppf.
pp [B0.Fpath.Set]
pp ~sep pp_elt ppf ss formats the elements of ss on ppf.
pp [B0.Fpath]
pp ppf p prints path p on ppf using B0.Fpath.to_string.
pp [B0.String.Map]
pp ~sep pp_binding ppf m formats the bindings of m on ppf.
pp [B0.String.Set]
pp ~sep pp_elt ppf ss formats the elements of ss on ppf.
pp [B0.String]
pp ppf s prints s's bytes on ppf.
pp_cmd_status [B0.OS.Cmd]
pp_cmd_status is a formatter for command process exit statuses.
pp_float_s [B0.Time]
pp_span ppf s prints an unspecified representation of s on ppf.
pp_info [B0.Variant]
pp_info ppf v prints v's synopsis and fields.
pp_info [B0.Def.S]
pp_info ppf v prints v's synopsis and fields.
pp_info_ext [B0.Variant]
pp_info ext ppf v prints v's synopsis and fields extended with ext.
pp_info_ext [B0.Def.S]
pp_info ext ppf v prints v's synopsis and fields extended with ext.
pp_level [B0.Log]
pp_level ppf l prints and unspecified representation of l on ppf.
pp_loc [B0.Sexp]
pp_loc ppf l prints an unspecified representation of l on ppf.
pp_log_line [B0.Outcome.Op]
pp_long [B0.Outcome.Op]
pp_name [B0.Variant]
pp_name ppf v prints v's name on ppf.
pp_name [B0.Def.S]
pp_name ppf v prints v's name on ppf.
pp_name_str [B0.Variant]
pp_name_str ppf s prints s as if it was a name on ppf.
pp_name_str [B0.Def.S]
pp_name_str ppf s prints s as if it was a name on ppf.
pp_quoted [B0.Fpath]
pp_quoted p prints path p on ppf using Filename.quote.
pp_short [B0_github.Release]
pp_short is a short formatter for issues.
pp_short [B0_github.Issue]
pp_short is a short formatter for issues.
pp_span [B0.Time]
pp_span ppf s prints an unspecified representation of s on ppf.
pp_span_uint_ns [B0.Time]
pp_span_uint_ns ppf s prints s as an unsigned 64-bit integer nanosecond span.
pp_spawn_fail [B0.Outcome.Op]
pp_stats [B0.Outcome]
pp_stats ppf o prints o's statistics on ppf.
pp_status [B0.Outcome.Op]
pp_status is a formatter for statuses.
pp_status [B0.OS.Cmd]
pp_status is a formatter for process exit statuses.
pp_synopsis [B0.Variant]
pp_synopsis ppf v prints v's synopsis: its name and documentation.
pp_synopsis [B0.Def.S]
pp_synopsis ppf v prints v's synopsis: its name and documentation.
pp_tool_alts [B0.Env]
pp_tool_alts can be used as a preamble for reporting failures to lookup tools e.g.
pp_unknown_scheme [B0.Variant]
pp_unknown_scheme ppf u prints an unspecified representation of u on ppf.
pp_value [B0.Conf]
pp_value k ppf v prints v's constant value or the fact that it is discovered.
print [B0.Conv]
print c is c's textual printer.
proxy [B0.Variant.Scheme]
proxy ?create ?setup ?delete run scheme is a proxy scheme variant using run to proxy the given build program command to build with variant scheme.
proxy_conf [B0.Variant.Scheme]
proxy_conf_b0_dir [B0.Variant.Scheme]
proxy_conf_root_dir [B0.Variant.Scheme]
proxy_conf_variant_dir [B0.Variant.Scheme]
proxy_create [B0.Variant.Scheme]
proxy_delete [B0.Variant.Scheme]
proxy_run [B0.Variant.Scheme]
proxy_run p cmd is the exit status of the run of the build command cmd via the proxy p.
proxy_setup [B0.Variant.Scheme]

Q
query [B0_json.Q]
query q j queries a JSON value j with q.
query_v4 [B0_github.Repo]
query_v4 auth r q performs the subgraph query q on repo r using authentication auth.
query_v4 [B0_github]
query_v4 auth q performs the the GitHub GraphQL V4 query q using authentication auth.

R
read [B0_ocaml.Deps]
read b file reads a B0_ocaml.Deps.write from file and continues with source file module dependencies to be compiled in a directory dst.
read [B0.Outcome]
read file reads a build outcome from file.
read [B0.Build]
read b file k reads the contents of file when it becomes ready and invokes k s.
read [B0.OS.File]
read file is file's content as a string.
read_file [B0.Outcome.Op]
read_file r is r's read file.
read_result [B0.Outcome.Op]
read_result r is r's result.
reads [B0.Outcome.Op]
reads o are the file paths read by operation.
ready [B0.Build]
ready b p declares path p to be ready in b.
rem [B0.Conf.Preset]
rem_preset p c is c with no bindings for p's keys.
rem [B0.Meta.Fpath.Map]
rem p k m removes the key k from p's metadata in m.
rem [B0.Hmap.MAP]
rem k m is m with k unbound.
rem_ext [B0.Fpath]
rem_ext ?multi p is p with the extension of p's basename removed.
req [B0_http]
req uri m ~headers ~body is a request on uri with method m, headers headers (defaults to []) and body body (defaults to "").
req_body [B0_http]
req_body r is r's body.
req_headers [B0_http]
req_headers r is r's headers.
req_json_v3 [B0_github.Repo]
req_json_v3 is like B0_github.Repo.req_json_v3 but performs given the root subpath on the given repo.
req_json_v3 [B0_github]
req_json_v3 auth path m ~headers body performs the request for json on path using method m, additional headers headers, body body and authentication auth.
req_meth [B0_http]
req_meth r is r's HTTP method.
req_uri [B0_http]
req_uri r is r's request URI.
reset [B0.Variant]
reset v resets variant v.
resolve [B0_ocaml.Lib]
resolve b r libs file lookups libs and their recursive dependencies in build b using resolver r.
resolve [B0.OS.Cmd]
resolve ~search cmd is like B0.OS.Cmd.must_exist except the tool of the resulting command value has the path to the tool of cmd as determined by B0.OS.Cmd.get_tool.
resp_body [B0_http]
resp_body r is the HTTP response body.
resp_headers [B0_http]
resp_headers r are the HTTP response headers.
resp_status [B0_http]
resp_status r is the HTTP response status.
reword_error [B0.R]
reword_error reword r is: r if r = Ok v, Error (reword e) if r = Error e
reword_error_msg [B0.R]
reword_error_msg ~replace reword r is like B0.R.reword_error except if replace is false (default), the result of reword old_msg is concatened, on a new line to the old message.
root [B0_driver.Cli]
root specifies a root directory to lookup the description from.
root_files [B0.Outcome]
root_file o is the set of root files in o.
root_libs [B0_ocaml.Lib]
root_libs s is the ordered set of libraries requested in the set.
run [B0.OS.Cmd]
run is B0.OS.Cmd.run_status with non-`Exited 0 statuses turned into errors via B0.OS.Cmd.pp_cmd_status.
run_out [B0.OS.Cmd]
run is B0.OS.Cmd.run_status_out with non-`Exited 0 statuses turned into errors via B0.OS.Cmd.pp_cmd_status.
run_status [B0.OS.Cmd]
run_status ~env ~cwd ~stdin ~stdout ~stderr cmd runs and wait for the completion of cmd in environment env with current directory cwd and standard IO connections stdin, stdout and stderr.
run_status_out [B0.OS.Cmd]
run_status_out is like B0.OS.Cmd.run_status except stdout is read from the process as a string.

S
s_driver_opts [B0_driver.Cli]
save [B0.Cache]
save t saves the cache.
save [B0.Conf]
save c file saves configuration c to file.
scheme [B0.Variant]
scheme v is v's scheme.
search_path_dirs [B0.OS.Cmd]
search_path_dirs ~sep s parses sep seperated file paths from s.
sel [B0_json.Q]
sel name q is obj get |> mem name q
set [B0_driver.Driver]
set d sets the driver to d.
set_current [B0.OS.Dir]
set_current dir sets the current working directory to dir.
set_current [B0.Def.Loc]
set_current loc sets the current location of definitions.
set_default_tmp [B0.OS.Dir]
set_default_tmp p sets the value returned by B0.OS.Dir.default_tmp to p.
set_default_variant_name [B0_driver.B0_dir]
set_default_variant_name d n sets the default variant name to n (if any).
set_default_variant_scheme_name [B0_driver.B0_dir]
set_default_variant_scheme_name d n sets the default variant name to n (if any).
set_ext [B0.Fpath]
set_ext ?multi p is add_ext ext (rem_ext ?multi p).
set_kmsg [B0.Log]
set_kmsg kmsg sets the logging function to kmsg.
set_level [B0.Log]
set_level l sets the current reporting level to l.
set_root [B0.Def.Loc]
set_root r sets the file source root to r.
set_sub_root [B0.Def.Loc]
set_sub_root r sets the file source sub root to r.
set_tty_styling_cap [B0.Fmt]
set_tty_styling_cap c sets the global styling capabilities to c.
singleton [B0.Hmap.MAP]
singleton k v is add k v empty.
some [B0.Conv]
option c wraps parses of c with Some _ note that this is exactly c: None can't be converted in either direction.
sp [B0.Fmt]
sp is Format.pp_print_space.
space [B0.Def.Name]
space () is the current namespace prefix.
spaced [B0.Def.Name]
spaced n namespaces n if there is a namespace prefix.
span [B0.String]
span ~sat s is (l,r) where l are the consecutive initial sat satisfying bytes of s or the empty string if there are no such bytes and r the remaining bytes.
spawn [B0.Build]
spawn b ~reads ~writes ~success ~env ~cwd ~stdin ~stdout ~stderr run spawns run once reads files are ready and makes files writes ready if the spawn succeeds and the file exists.
spawn [B0.OS.Cmd]
spawn ~env ~cwd ~stdin ~stdout ~stderr cmd spawns command cmd in environment env with current directory cwd and standard IO connections stdin, stdout and stderr.
spawn_allowed_exits [B0.Outcome.Op]
spawn_allowed_exits s is the list of exit codes denoting success for the operation.
spawn_cmd [B0.Outcome.Op]
spawn_cmd s is s's invocation.
spawn_cwd [B0.Outcome.Op]
spawn_cwd s is the current working directory in which s was run.
spawn_env [B0.Outcome.Op]
spawn_env s is the environment in which s was run.
spawn_result [B0.Outcome.Op]
spawn_result s is s's OS completion result or an error.
spawn_stderr [B0.Outcome.Op]
spawn_stderr s is destination to which stderr was written for s.
spawn_stdin [B0.Outcome.Op]
spawn_stdin s is file where stdin was read from for s (if any).
spawn_stdo_ui [B0.Outcome.Op]
spawn_stdo_ui s is the `Ui redirection result of s.
spawn_stdout [B0.Outcome.Op]
spawn_stdout s is destination to which stdout was written for s.
split_ext [B0.Fpath]
split_ext ?multi p is (rem_ext ?multi p, get_ext ?multi p).
src [B0.Build]
src b src is:
let src = Fpath.(src_dir b // src) in
ready b src; src
src_dir [B0.Build]
src_dir b is the path to b's current source root, where non-built (source) files are expected too be looked up.
src_root [B0.Unit]
src_root u is the root of sources for the units.
srcs [B0_ocaml.Build]
src b dir is (ml_srcs, c_srcs) where ml_srcs are files ending up in .ml and .mli in dir and c_srcs the files ending up in .c and .h.
stacktraces [B0_ocaml.Conf]
stacktraces is true if stacktrace support should be compiled.
stacktraces [B0_ocaml.Key]
stacktraces is true if stacktrace support should be compiled.
stamp [B0.Outcome.Op]
stamp o is o's stamp.
start [B0.Build]
start b starts the build.
status [B0.Outcome.Op]
status o is o's status.
stored_conf [B0.Build]
strf [B0]
strf is Format.asprintf.
string [B0_json.G]
str s is s as a generated JSON string value.
string [B0_json.Q]
string queries a string JSON value.
string [B0.Hash]
string s is the hash of s.
string [B0.Conv]
string is a converter for strings.
string [B0.Fmt]
string is Format.pp_print_string.
string_non_empty [B0.Conv]
string_non_empty is a converter for non-empty strings.
strip_escapes [B0.Tty]
strip_escapes s removes ANSI escapes from s.
styled_str [B0.Tty]
styled_str cap styles s styles s according to styles and cap.
suggest [B0.String]
suggest ~dist candidates s are the elements of candidates whose edit distance is the smallest to s and at most at a distance of dist of s (defaults to 2).
sync_units [B0.Outcome.Op]
sync_units s is the units on which s synchronizes.

T
tag [B0_ocaml.Unit]
tag indicates the unit deals with OCaml related outcomes.
tag_name [B0_github.Release]
tag_name r is the tag name of the release.
take [B0.String]
take ~sat s is fst (span ~sat s).
test [B0_care.Unit]
test is for units with testing outcomes.
text [B0.Conv]
text (parse, print) is a textual converter using parse to parse text into values and print to pretty-print values.
text [B0.Fmt]
text is Format.pp_print_text.
time [B0.Log]
time ~level m f v logs m with level level (defaults to Info) and the time f v took as the log header.
title [B0_github.Issue]
title i is the issue's title.
tmp_vars [B0.Tool]
tmp_vars is ["TMPDIR"; "TEMP"; "TMP"].
to_assignments [B0.OS.Env]
to_assignments env is env's bindings as a list of strings of the form "var=value".
to_bytes [B0.Hash]
to_bytes h is the sequence of bytes of the hash h.
to_dir_path [B0.Fpath]
to_dir_path p is add_seg p "".
to_hex [B0.Hash]
to_hex h is the sequence of bytes of the hash h as US-ASCII hexadecimal digits.
to_list [B0.Cmd]
to_list l is l as a list of strings.
to_ns [B0.Time]
to_ns s is s in nanoseconds (1e-9).
to_rev_list [B0.Cmd]
to_rev_list l is l as a reversed list of strings.
to_string [B0_json.G]
to_string g is the generated JSON value g as a string.
to_string [B0_json]
to_string v is v as JSON text, encoded according to RFC8259
to_string [B0.Cmd]
to_string l converts l to a string that can be passed to the command(3) POSIX system call.
to_string [B0.Fpath]
to_string p is the path p as a string.
to_string_map [B0.Sexp]
to_string_map ~known se is (known, unknown).
to_uint64_ns [B0.Time]
to_uint64_ns s is s as an unsigned 64-bit integer nanosecond span.
to_units [B0_jbuilder]
add_units j translate the library and executable[s] stanzas as B0_ocaml build units.
tool [B0_ocaml.Build]
tool ~name b u c args is a run for a tool named basename compiled via B0_ocaml.Build.exe in u with configuration c.
tool [B0.Build]
tool b t args is t's tool for the build is a run for the tool t with args.
tool [B0.Env]
tool e aim tools is the first file executable which can be found among tools for spawns which aim at producing artefacts for aim.
tool [B0.Conv]
tool is a converter for a command line tool name or file path.
toolchain [B0_c]
toolchain is the C toolchain used.
total_dur [B0.Build]
total_dur b is the current total wall-time duration.
tty [B0.Fmt]
tty styles pp_v ppf v prints v with pp_v on ppf according to styles and the value of B0.Fmt.tty_styling_cap.
tty_str [B0.Fmt]
tty_str styles ppf s prints s on ppf according to styles and the value of B0.Fmt.tty_styling_cap.
tty_styling_cap [B0.Fmt]
tty_styling_cap () is the global styling capability.

U
unique [B0.String]
unique ~exist n is n if exists n is false or r = strf "%s~%d" n d with d the smallest integer in [1;1e9] such that exists r is false or an error if there is no such string.
uniquify [B0.Fpath]
uniquify ps is ps without duplicates, the list order is preserved.
uniquify [B0.String]
uniquify ss is ss without duplicates, the list order is preserved.
unit [B0.Build]
unit b is the unit being built.
unit [B0.Fmt]
unit fmt formats a unit value with the format fmt.
unit_build_dir [B0.Build]
unit_build_dir b u is the build directory of unit u.
unit_id [B0.Outcome.Op]
unit_id o is the identifier of the unit in which the operation was submitted.
unit_id_name_map [B0.Outcome]
unit_id_name_map o maps identifiers of units built in o to their name.
unit_id_set [B0.Outcome]
unit_id_set names o is the set of unit identifers that matches names in o.
unit_names [B0.Outcome]
unit_names o are the names of the units that were built.
units [B0.Build]
units b are the unit that are being built.
upload_asset [B0_github.Release]
upload_asset auth repo r ~content_type ~name asset uploads assets content asset with file name name and content type content_type in release r of repo r.
url [B0_github.Issue]
url i is the issue's url.
user [B0.OS.Dir]
user () is the home directory of the user executing the process.

V
v [B0_github.Repo]
repo ~owner name identifiers a GitHub repository.
v [B0_driver.B0_dir]
v ~b0_dir is a b0 directory located at b0_dir which might not exist.
v [B0.Variant.Scheme]
v ?src ?doc name kind is the variant scheme named name with kind kind.
v [B0.Tool]
v ~internal ~env_vars name is a tool looked up in the build's search path as name.
v [B0.Conf.Preset]
v name ~doc defs is a preset with unique name n, key-value definitions defs an documented by doc.
v [B0.Conf.Key]
v [B0.Conf.Group]
v n ~doc is a key group with unique name n documented by doc.
v [B0.Env]
v ~build_lookup ~build_forced_env ~build_env ~host_lookup ~host_forced_env host_env is an environment with: host_env, the consulted process environment for tools which aim at producing artefacts for the `Host_os., host_forced_env, an overriding process environment passed to all tools which aim at producing artefacts for the `Host_os (defaults to String.Map.empty)., host_lookup, the tool lookup function for tools which aim at producing artefacts for the `Host_os (defaults to env_tool_lookup host_env)., build_env, the consulted process environment for tools which aim at producing artefacts for the `Build_os (defaults to host_env)., build_forced_env, an overriding environment passed to all tools which aim at producing artefacts for the `Build_os (defaults to host_forced_env)., build_lookup, the tool lookup function for tools which aim at producing artefacts for the `Build_os (defaults to env_tool_lookup build_env if build_env is defined explicitely or host_lookup otherwise).
v [B0.Hmap.KEY]
v n conv info ~doc is a new key with name n using conv to convert values, info as key information and documented by doc (default to "").
v [B0.Conv]
v ~docv ~codec text is a value converter using text for textual conversions and codec for binary conversions.
v [B0.Cmd]
v cmd is a new command line (or command line fragment) whose first argument is cmd.
v [B0.Fpath]
v s is the string s as a path.
value [B0.Conf]
value k c v determines the value of v with respect to k and c (for B0.Conf.discovered).
value [B0.OS.Env]
value ~empty_is_absent name conv ~absent is like B0.OS.Env.get except the variable value is parsed using conv's textual parser.
value_const [B0.Conf]
value_const d is d's constant value (if any).
value_kind [B0.Variant]
value_kind [B0.Def.S]
The kind of value.
value_store [B0.Conf]
value_store d is true if the discovered value should be stored.
variant [B0_driver.Cli]
variant specifies the variant name to act upon.
variant_dir [B0_driver.B0_dir]
variant_dir d is the directory where variants are located.
variant_env [B0_driver.Cli]
variant_env is the environment variable used to specify the default environment.
variant_scheme [B0_ssh]
variant_scheme host s is a variant scheme that compiles the project using scheme s on the SSH host host.
variant_scheme [B0_opam]
variant_scheme name is a variant scheme that compiles in an environment setup by opam env --switch name.
variant_scheme [B0_driver.Cli]
variant_scheme [B0_docker]
variant_scheme image s is a variant scheme that compiles the project using scheme s in a docker container image image which is assumed to exist.
variant_scheme_env [B0_driver.Cli]
vbox [B0.Fmt]
vbox is like B0.Fmt.box but is a vertical box: every break hint leads to a new line which adds indent to the current indentation (default to 0).
verbosity [B0_driver.Cli]
verbosity specifies the log verbosity.
verbosity [B0_driver.Driver]
verbosity s is the requested log verbosity.
version [B0_care.OS]
version is the operating system version string.

W
warn [B0.Log]
warn is msg Warning.
warn_count [B0.Log]
warn_count () is the number of messages logged with level Warning.
with_current [B0.OS.Dir]
with_current dir f v is f v with the current working directory bound to dir.
with_docv [B0.Conv]
with_docv c docv is c with docv as a documentation meta-variable.
with_ic [B0.OS.File]
with_ic file f v opens file as a channel ic and returns Ok (f ic v).
with_index_range [B0.String]
with_index_range ~first ~last s are the consecutive bytes of s whose indices exist in the range [first;last].
with_oc [B0.OS.File]
with_oc file f v opens file as a channel oc and returns Ok (f oc v).
with_preset [B0.Variant.Scheme]
with_preset s preset n is the scheme s but with name n and preset preset.
with_tmp_oc [B0.OS.File]
with_tmp_oc ~flags ~mode ~ext p f v is Ok (f file oc v) with file a file path atomatically created and opened with permission mode (defaults to 0o600 only readable and writable by the user) on the output channel oc.
wrap [B0.Variant.Scheme]
wrap snd fst n is a scheme named n that behaviourly performs the functional composition snd o fst.
write [B0_ocaml.Deps]
write b ~srcs file computes module dependencies of srcs to file in b.
write [B0.Outcome.Op]
write u f, when submitted, starts to atomically set the contents of f to write_data w.
write [B0.Outcome]
write file o writes the build outcome o to file file.
write [B0.Build]
write b ~reads f gen once reads are ready writes gen () to f assuming the result depends only on reads.
write [B0.OS.File]
write file content outputs content to file.
write_data [B0.Outcome.Op]
write_data w is w's written data.
write_file [B0.Outcome.Op]
write_file w is w's written file.
write_result [B0.Outcome.Op]
write_result w is w's result.
writes [B0.Outcome.Op]
writes o writes are the file paths written by o.

Z
zero [B0.Hash]
zero is the zero hash, a sequence of null bytes.
zero [B0.Time]
zero is a span of 0ns.