Index of values

f $ v is app f v.

a &&& b is const ( && ) $ a $ b.

See Assemblage.Path.(+).

See Assemblage.Path.(+).

p + ext is add_ext p e.

See Assemblage.Path.(/).

See Assemblage.Path.(/).

p / c is add p c.

path / seg is Conf.(const Path.( / ) $ path $ const seg).

See Assemblage.Path.(//).

See Assemblage.Path.(//).

p // p' is concat p p'.

path // rel is Conf.(const Path.( // ) $ path $ rel).

( =+= ) is Makefile.Infix.(=+=).

v =+= def is v += def.

( =::= ) is Makefile.Infix.(=::=).

v =::= def is v ::= def.

( =:= ) is Makefile.Infix.(=:=).

v =:= def is v := def.

( === ) is Makefile.Infix.(===).

v === def is v = def.

( =?= ) is Makefile.Infix.(=?=).

v =+= def is v += def.

(>>=) is Assemblage.Cmd.(>>=).

r >>= f is bind r f.

(>>|) is Assemblage.Cmd.(>>|).

r >>| f is map r f.

a @@@ a' is append a a'.

a &&& b is const ( || ) $ a $ b.

path converts value with Assemblage.Path.of_string.

actions p are the actions to build part p.

add c k is c with k bindings to its default value.

add v l is v :: l.

See Assemblage.Path.add.

See Assemblage.Path.add.

add p seg concatenates seg at the end of p.

add_ctx_args ctx args t adds context ctx and argument bundle args to t.

See Assemblage.Path.add_ext.

See Assemblage.Path.add_ext.

add_ext p ext is p with ext concatenated to p's last segment.

add_if c v l is add v l if c is true and l otherwise.

adds l l' adds l in front of l'.

adds_if c l l' if adds l l' if c is true and l' otherwise.

all is a specifier that keeps any product of any part.

all_input is a specifier that keeps any input product of any part.

all_output is a specifier that keeps any output product of any part.

app f v is a configuration value that evaluates to the result of applying the evaluation of v to the one of f.

append a a' is the bundle that has the bindings of a and a'.

args p is p's args.

args p is p's user defined argument bundle.

args a is a's argument bundle.

args c are c's arguments.

args_with_ctx conf context args cmd are c's arguments prepended with the arguments found in args for the configuration conf and the context Assemblage.Private.Acmd.ctxcontext c.

assemble p registers p for assembling by an assemblage driver.

base name is add empty f.

base name is add empty f.

See Assemblage.Path.basename.

See Assemblage.Path.basename.

basename p is the basename of p.

bin bin args is like Assemblage.Run.with_bin but directly executes the binary with args and redirects its outputs as specified.

bin is Assemblage.Dir.all_output except in the following cases: For `Bin parts of kind `OCaml keeps only one of the byte and native code executable without its extension. If both are available favors native code over byte code., For `Bin parts of kind `C keeps only the part's executable.

See Assemblage.Bin.v.

bind r f is f v if r = `Ok v and r if r = `Error _.

bool converts values with bool_of_string.

build_dir is the path to the build directory expressed relative to the Assemblage.Conf.root_dir (defaults to "_build").

byte p is true if p can compile to OCaml byte code.

byte p is true if p can compile to OCaml byte code.

c p is Some p iff p is an `C binary.

c p is Some p iff p is a `C library.

c p is Some p iff p is a C compilation unit.

c_dynlink is true iff C dynamic linking compilation is requested (default to true).

c_js is true iff C JavaScript compilation is request (defaults to false).

cat is the cat (defaults to "cat" on Unix and "type" on Windows).

cc is the C compiler (defaults to "cc")

The -cclib x args.

The -ccopt x args.

cd has a command exec dir to change directory to dir.

cd is the cd utility (defaults to "cd").

See Assemblage.Path.change_ext.

See Assemblage.Path.change_ext.

change_ext p e is add_ext (rem_ext p).

chdir dir changes the current working directory to dir.

check p logs information about potential problems with p and returns true if there is no such problem.

cmd name is a program whose name is the value of name.

cmd_key c is c's configuration key used to define Assemblage.Private.Acmd.cmd_name (if any).

cmd_name c is c's command name.

cmds a is a's commands to generate outputs from the inputs.

coerce k p coerces p to kind k,

coerce_if k p is Some if p is of kind k and None otherwise.

compare k k' compares k and k' and is compatible with Assemblage.Private.Conf.Key.equal.

compare p p' is compare (id p) (id p').

See Assemblage.Path.compare.

See Assemblage.Path.compare.

compare p p' is Pervasives.compare p p'.

concat args is List.fold_left append empty args

See Assemblage.Path.concat.

See Assemblage.Path.concat.

concat p p' concatenates p' at the end of p.

conf p is the project's configuration.

const v is a configuration value that evaluates to v.

converter k is k's value type converter.

cp has a command exec src dst to copy file src to dst.

cp is the cp utility (defaults to "cp" on Unix and "copy" on Windows).

create () returns a function to inject and a function to project a value from a given type in to/from a universal value.

ctx p is a context that describes p using part context elements.

ctx context c is context augmented with c's context.

ctx a is a's context.

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 non empty separator string sep or None if sep can't be matched in s.

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 non empty separator string sep or None if sep can't be matched in s.

See Assemblage.Path.dash.

dash is the "-" relative path.

debug is true iff build products in general must support debugging (defaults to false).

debug info ... logs a message with level Debug.

def k v is a definition that binds key k to value v.

default k is k's default value.

default is a part filter that selects only OCaml units whose Assemblage.Unit.ocaml_interface is not `Hidden.

defv k v is a definition that binds key k to value v.

delete ~maybe file deletes file file.

deps p is the set of configuration keys which may be needed for evaluating the constituents of p.

deps a is the set of configuration keys which may be needed for evaluating a.

deps a is the set of configuration keys which may be needed for evaluating the constituents of a.

deps v is the set of configuration keys which may be needed for evaluating v.

describe dirty d vcs identifies the HEAD commit using tags from the VCS vcs in directory d.

dev is part filter that select any kind of OCaml unit.

dev_null is a file that discards all writes.

dev_null represents a file that discards all writes.

dir u is the directory where the unit u is located.

See Assemblage.Dir.v.

See Assemblage.Path.dirname.

See Assemblage.Path.dirname.

dirname p is the dirname of p.

doc k is k's documentation string (if any).

doc is Assemblage.Dir.all except in the following cases: For `Doc parts of kind `OCamldoc it is any_output.

doc is true iff documentation should be built (defaults to false).

See Assemblage.Doc.v.

docs k is k's documentation section (if any).

docs_build_directories is the name of the documentation section in which build directory keys are described.

docs_build_properties is the name of the documentation section in which build property keys are described.

docs_c_system is the name of the documentation section in which C system keys are described.

docs_machine_utilities is the name of the documentation section in which machine information keys are described.

docs_ocaml_system is the name of the documentation section in which OCaml system keys are described.

docs_project is the name of the documentation section in which project keys are described.

docs_system_utilities is the name of the documentation section in which system utility keys are described.

docv k is k's value documentation meta-variable (if any).

dom m is the domain of m.

dom m is the domain of m.

dom m is the domain of m.

dom m is the domain of m.

dom m is the domain of m.

dom m is the domain of m.

dom m is the domain of m.

domain c is the configuration keys of c.

echo is the echo utility (defaults to "echo").

empty is the empty configuration.

empty is the empty bundle.

See Assemblage.Path.empty.

empty is the empty relative path (empty list of segments).

enum l converts values such that string names in l map to the corresponding value of type 'a.

env var is the value if the environment variable var, if defined.

equal k k' is true iff name k = name k'.

equal p p' is (id p) = (id p').

See Assemblage.Path.equal.

See Assemblage.Path.equal.

equal p p' is p = p'.

err fmt ... logs a message with level Error.

err_count () is the number of messages logged with level Error.

error e is `Error e.

eval p v is Conf.eval [conf p] v.

eval c v evaluates v in the configuration c.

eval_key p k is eval p (Conf.value k).

exec cmd args executes cmd with arguments args.

exec_ret cmd args executes cmd with arguments args and returns the exit code of the invocation.

exists p is p's condition of existence.

exists ?ext bin is true if the to_cmd bin command exists.

exists p determines if p exists.

exists d vcs is true if the VCS vcs is detected in directory d.

exists dir is true if directory dir exists.

exists file is true iff file exists and is not a directory.

exists path is true iff path exists.

exists cmd is true if cmd exists and can be invoked.

See Assemblage.Path.ext.

See Assemblage.Path.ext.

ext p is p's last segment file extension (if any).

See Assemblage.Path.ext_matches.

See Assemblage.Path.ext_matches.

ext_matches exts p is true iff p's last segment has a file extension in exts.

ext_of_string ext is ext as a file extension (ext without separator).

ext_to_string ext is ext as a string (without separator).

add_if c f v l is add (f v) l if c is true and l otherwise.

fadds_if c (f v) l is adds (f v) l if c is true and l otherwise.

false_ is const false.

file p is a part with a noop action that inputs p.

file name is add empty f.

file name is add empty f.

See Assemblage.Part.file.

file_exts exts is a specifier that keeps, in any part, products that have an extension in exts.

find c k is the binding of k in c (if any).

find d looks for an arbitrary VCS in directory d.

See Assemblage.Path.find_prefix.

See Assemblage.Path.find_prefix.

find_prefix p p' is a common prefix for p and p'.

fold_files_rec skip f acc paths folds f over the files found in paths.

with_ctx conf ctx args is the arguments in args for context ctx in configuration conf.

gen ext bin args is a part that uses Assemblage.Bin.to_cmd to generate a product on stdout.

get () is the library's current preferences.

get c k is the binding of k in c.

get none v is the value of the option v.

get d is like Assemblage.Cmd.Vcs.exists but returns an error if no VCS was found.

get r is v if r = `Ok v and

get_env var is like Assemblage.Cmd.env but returns an error if var is undefined.

See Assemblage.Path.get_ext.

See Assemblage.Path.get_ext.

get_ext p is p's last segment file extension.

get_meta proj p uses proj on p's metadata.

getcwd () is the current working directory.

See Assemblage.Path.has_ext.

See Assemblage.Path.has_ext.

has_ext p ext is true iff p's last segment has file extension ext.

head dirty d vcs is the HEAD commit identifier of the VCS vcs in in directory d.

hide_type k hides the type parameter of k.

host_arch is the hardware architecture of the host machine (defaults to the value of the driver's "PROCESSOR_ARCHITECTURE" environment variable if the driver Sys.os_type is "Win32" otherwise it is the lowercased result of Assemblage.Conf.uname invoked with -m)

host_os is the operating system name of the host machine (defaults is "Win32" if the driver's Sys.os_type is "Win32" otherwise it is the lowercased result of Assemblage.Conf.uname invoked with -s).

host_word_size is the host machine word bit size (defaults to the driver's Sys.word_size).

id k is the unique id of the key.

id p is a unique id for the part.

ignore_error ~use r is like Assemblage.Cmd.on_error but the error is not logged.

info fmt ... logs a message with level Info.

init ?version_opt ?kinds ~docs an initialization value (init,t).

inputs a is the list of products input by a's action.

kind p is true if the directory contents is meant to be installed.

int converts values with int_of_string.

integrate ?add_need i p is i as integrated in p.

is_abs p is true iff p is an absolute path.

See Assemblage.Path.is_dash.

is_dash p is true iff p is Assemblage.Path.dash.

is_empty c is true iff c is empty.

is_empty a is true if a is empty.

See Assemblage.Path.is_empty.

is_empty p is true iff p is Assemblage.Path.empty.

See Assemblage.Path.is_prefix.

See Assemblage.Path.is_prefix.

is_prefix p p' is true if p is a literal prefix of p'.

is_rel p is true iff p is a relative path.

See Assemblage.Path.is_root.

is_root p is true iff p is Assemblage.Path.root.

jobs is the number of jobs to run for building (defaults to machine processor count).

js p is true if p can compile to JavaScript code.

js p is Some p iff p is a JavaScript compilation unit.

js_of_ocaml is the js_of_ocaml utility (defaults to "js_of_ocaml").

key public docs docv doc name conv v is a configuration key named name that maps to value v by default.

kind p is p's kind.

kind p is p's kind.

kind p is p's package kind.

kind p is p's kind.

kind p is the kind of p.

kind u is the kind of u.

kind p is p's kind.

kmsg header k l fmt ... is like msg header l fmt but calls k () before returning.

level () is the log level (if any).

lib is Assemblage.Dir.all_output except in the following cases: For `Lib parts of kind `OCaml, keeps only the library's archives and the library's unit's cmx, cmi and cmti files according to their interface specification., For `Lib parts of kind `C, keeps only the library's archives.

See Assemblage.Lib.v.

linkall is the -linkall flag in the right `OCaml contexts.

list is the list of projects that were Assemblage.assembled by the library so far.

list_actions ps is the list of actions of the parts ps.

list_fold f acc ps is List.fold_left f acc ps.

list_fold kind f acc ps is like Assemblage.Part.list_fold but folds only over the parts whose kind is kind.

list_fold_kind_rec is the same traversal as Assemblage.Part.list_fold_rec but only parts whose kind is kind are folded over.

fold_rec f acc l folds over the parts of l and their needs recusively, in depth first pre-order.

list_inputs l is the list of inputs of the actions in l.

list_keep pred ps is the elements of ps that satisfy pred.

list_keep_kind k ps is the elements of ps that have kind kind.

list_keep_kinds ks is the elements of ps that have one of the kind ks.

list_keep_map f ps is the elements of ps for which f returns Some value.

list_lookup ps is a lookup function that looks up all package in ps and returns the aggregated result.

list_outputs l is the list of outputs of the actions in l.

list_products l is list_inputs l @ list_outputs l but tail-recursive.

list_uniquify ps is ps with duplicates as determined by Assemblage.Part.equal removed.

ln has a command exec src dst to link symbolically file src to dst.

ln is the ln utility (defaults to "ln").

ln_rel has a command exec src dst to link symbolically file src to dst.

load l loads according to settings l.

log a is a's high-level logging string (if any).

query p q is p's lookup function.

make is the make utility (defaults to "make").

make_unique_in ~suff set elt is a string that does not belong set.

make_unique_in ~suff set elt is a string that does not belong set.

man c is a man page fragment for the the term ui c.

man_vars kinds is a man page fragment for the environment variables used by Assemblage_driver.Driver.init.

man_vars is a man page fragment for the environment variables used by Assemblage_driver.Loader.ui.

man_vars is a man page fragment for the environment variables used by Assemblage_driver.Lib_prefs.ui.

map r f is bind r (fun v -> ret (f v)).

matches c c' is true if context c matches c', that is if c is a subset of c'.

mem c k is true iff k is in c.

merge c c' merge the configuration c and c'.

meta p is p's metadata.

meta_key () pairs a metadata injector and projector.

meta_nil is metadata that cannot be accessed.

mkdir has a command exec d to create the directory p.

mkdir is the mkdir (defaults to "mkdir").

move src ~dst moves src to dst.

move ~force src dst moves path src to dst.

msg header l fmt ... logs a message with level l.

mv has a command exec src dst to move path src to dst.

mv is the mv utility (defaults to "mv" on Unix and "move" on Windows).

name k is k's name.

name p is the p's name.

name p is p's name.

native p is true if p can compile to native code.

native p is true if p can compile to native code.

native p is true if p can compile to native dynamically linked code.

needs p is the (uniqified) list of parts needed by p to define itself.

neg a is const ( not ) $ a.

nop does nothing.

ocaml p is Some p iff p is an `OCaml binary.

ocaml p is Some p iff p is an `OCaml library.

ocaml p is Some p iff p is an OCaml compilation unit.

ocaml is the ocaml utility (defaults to "ocaml").

ocaml_annot is true iff OCaml binary annotation files generation is requested (defaults to true).

ocaml_build_ast is true if OCaml source AST should be built and dumped to a file with Assemblage.Conf.ocaml_dumpast (defaults to false).

ocaml_byte is true iff OCaml byte code compilation is requested (defaults to true).

ocaml_dumpast is the ocaml-dumpast utility (defaults to "ocaml-dumpast").

ocaml_js is true iff OCaml JavaScript compilation is requested (defaults to false).

ocaml_native is true iff OCaml native code compilation is requested (defaults to true).

ocaml_native_dynlink is true iff OCaml native code dynamic linking compilation is requested (defaults to true).

ocaml_native_tools is true to use the native compiled (.opt) OCaml tools (defaults to true).

ocaml_pp p is Some p iff p is `OCaml_pp library.

ocaml_toplevel p is Some p iff p is an `OCaml_toplevel binary.

ocaml_version is the OCaml compiler version (defaults is inferred by invoking an OCaml compiler).

ocamlc is the ocamlc utility (defaults to "ocamlc" or "ocamlc.opt" according to Assemblage.Conf.ocaml_native_tools).

ocamldebug is the ocamldebug utility (defaults to "ocamldebug").

ocamldep is the ocamldep utility (defaults to "ocamldep" or "ocamldep.opt" according to Assemblage.Conf.ocaml_native_tools).

ocamldoc p is Some p iff p is an `OCamldoc documentation generator.

ocamlfind p is Some p iff p is an `OCamlfind package.

ocamlfind is the ocamlfind utility (defaults to "ocamlfind").

ocamllex is the ocamllex utility (defaults to "ocamllex" or "ocamllex.opt" according to Assemblage.Conf.ocaml_native_tools).

ocamlmklib is the ocamlmklib utility (defaults to "ocamlmklib").

ocamlopt is the ocamlopt utility (defaults to "ocamlopt" or "ocamlopt.opt" according to Assemblage.Conf.ocaml_native_tools).

ocamlprof is the ocamlprof utility (defaults to "ocamlprof").

ocamlrun is the ocamlrun utility (defaults to "ocamlrun").

ocamlyacc is the ocamlyacc utility (defaults to "ocamlyacc").

of_abs a is a as a path.

of_keys ks is a configuration where each key in ks binds to its default value.

of_list ss is a set from the list ss.

of_list ss is a set from the list ss.

of_project p is a merlin file for project p.

of_project p is a META file for project p.

of_project add p is an install file for project p and add.

of_rel r is r as a path.

of_segs segs is a path from segs segments.

of_segs segs is a path from segs segments.

of_segs segs is a path from segs segments.

of_string s is the string s as a path.

on_error ~level ~use r is: v if r = `Ok v, use if r = `Error msg. As a side effect msg is logged with level level (defaults to Log.Error)

opam is the opam tool (defaults to "opam").

opam_admin is the opam-admin tool (defaults to "opam-admin")

opam_installer is the opam-installer tool (defaults to "opam-installer")

opt p is true if the package is optional.

c p is Some p iff p is a C package.

outputs a is the list of products output by a's action.

override_bin is the current VCS executable override.

override_kind () is the current VCS kind override value.

parser c is c's parser.

parts p is p's parts.

path ext is Assemblage.Path.change_ext path ext.

path converts value with Assemblage.Path.of_string.

path_arg p l is Path.to_string p :: l.

path_args ?opt ps l is like Assemblage.Acmd.Args.path_arg but for each element of ps.

pick_if c a b is a if c evaluates to true and b otherwise.

See Assemblage.Pkg.v.

pkg_config p is Some p iff p is a `Pkg_config package.

pkg_config is the pkg-config utility (defaults to "pkg-config").

pp ppf l prints an unspecified representation of l on ppf.

pp ppf p prints an unspecified representation of p on ppf.

pp conf ppf a prints an unspecified representation of a in context conf on ppf.

pp ppf c prints an unspecified representation of c on ppf.

pp conf ppf args prints an unspecified representation of args in context conf on ppf.

pp ppf c prints an unspecified representation of c on ppf.

pp ppf c prints an unspecified representation of c on ppf.

See Assemblage.Path.pp.

See Assemblage.Path.pp.

pp ppf p prints path p on ppf using Assemblage.Path.to_string.

pp is Format.fprintf

pp_bool is Format.pp_print_bool.

pp_cut is Format.pp_print_cut.

pp_doomed should be used for printing a message when reasonable assumptions are being violated.

pp_elt ppf e prints an unspecified representation of e on ppf.

pp_ext ppf p prints file extension ext on ppf using Assemblage.Path.ext_to_string.

pp_if_utf8 pp_u pp is a formatter that will use pp_u if UTF-8 output is enabled by the driver and pp otherwise.

pp_int is Format.pp_print_int.

pp_key_dup ppf k prints a message that says that the name of k is not unique in a configuration.

pp_kind ppf kind prints an unspecified representation of kind on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified representation of k on ppf.

pp_kind ppf k prints an unspecified represetation of k on ppf.

pp_larrow formats a left arrow.

pp_lines formats lines by replacing newlines in the string with calls to Format.pp_force_newline.

pp_list pp_sep pp_v formats lists of type 'a.

pp_opt pp_none pp_v formats value of type 'a option.

pp_rarrow formats a right arrow.

pp_signature ppf p prints an unspecified signature for p on ppf, includes the project name and version.

pp_sp is Format.pp_print_space.

pp_str is Format.pp_print_string.

pp_styled style pp formats according to pp but styled with style.

pp_styled_str style is pp_styled_str style pp_str.

pp_text formats text by replacing spaces and newlines in the string with calls to Format.pp_print_space and Format.pp_force_newline.

pp_usage ppf u prints an unspecified representation of u on ppf.

converter c is c's printer.

products kind p is the set of products known to the project in the current configuration.

products a is inputs a @ outputs a but tail recursive.

profile is true iff build products in general must support profiling (defaults to false).

project_version is the version number of the project (defaults is inferred from the VCS).

public k is k's public status.

See Assemblage.Path.quote.

See Assemblage.Path.quote.

quote p is the path p as a string, quoted according to the driver's platform conventions with Filename.quote.

rcut sep s is like As_string.cut but the matching is done backwards starting from the end of s.

rcut sep s is like Assemblage.String.cut but the matching is done backwards starting from the end of s.

read file is file's content.

read cmd args execute cmd with arguments args and returns its standard output.

read_lines file is file's content splitted at '\n'.

input_lines cmd args is like input ~trim:false cmd args but the input is splitted at '\n'.

redefine check actions p is p with check function check and actions function action (both defaults to p's one if unspecified).

path converts value with Assemblage.Path.of_string.

rem c k is c without k's binding.

See Assemblage.Path.rem_ext.

See Assemblage.Path.rem_ext.

rem_ext p is p with ext removed from p's last segment (if it has an extension).

See Assemblage.Path.rem_prefix.

See Assemblage.Path.rem_prefix.

rem_prefix pre p is p with the literal prefix pre removed.

ret v is `Ok v.

reword_error msg r uses msg for the error message in case of `Error.

rm is the rm utility (defaults to "rm" on Unix and "del" on Windows).

rm_dirs has a command exec ~f ~r paths to remove the directory paths paths.

rm_files has a command exec ~f paths to remove the file paths paths.

rmdir is the rmdir utility (defaults to "rmdir").

root p is p's root build directory expressed relative to Assemblage.Conf.root_dir.

See Assemblage.Path.root.

root is the root absolute path (empty list of segments).

root is the current directory relative to the project root.

root_dir is the absolute path to the project directory (defaults to the driver program current directory).

root_path is like Assemblage.Part.root but as a generic path.

rpp is pp fmt ppf

rsplit sep s is like As_string.split but the matching is done backwards, starting from the end of s.

rsplit sep s is like Assemblage.String.split but the matching is done backwards, starting from the end of s.

rule ext order_only_prereqs targets prerequs recipe () is a makefile rule.

See Assemblage.Run.v.

scheme base name defs is a configuration scheme named name that has the key-value bindings of base together with those of defs, the latter taking precedence.

scheme_man sl is a man page fragment for the term scheme_ui sl.

scheme_ui sl is a Cmdliner term that allows to select a configuration scheme from the list of schemes sl.

schemes p is p's configuration schemes.

set p sets the library preferences to p.

set c k v is c with k binding to v.

set_formatter spec ppf sets the formatter for a given level or for all the levels according to spec.

set_level l sets the log level to l.

set_override_exec (Some vcs_exec) uses vcs_exec as the VCS executable, use in conjunction with Assemblage.Private.Cmd.Vcs.set_override_kind otherwise it has no effect.

set_override_kind (Some vcs) has the effect of bypassing VCS discovery.

set_style_tags s sets the current tag style used by Assemblage.Fmt.pp_styled.

set_utf8_enabled b sets UTF-8 pretty-printing to b.

show fmt ... logs a message with level Show.

slice ~start ~stop s is the string s.

slice ~start ~stop s is the string s.

some v is the value of v as a Some value.

split sep s is the list of all (possibly empty) substrings of s that are delimited by matches of the non empty separator string sep.

split sep s is the list of all (possibly empty) substrings of s that are delimited by matches of the non empty separator string sep.

stamp has a command execs f content that writes content to f.

static name is a program whose name is name.

stderr c is c's stderr redirection (if any).

stdin c is c's stdin redirection (if any).

stdout c is c's stdout redirection (if any).

string converts values with the indentity function.

stub s adds -cclib -ls -dllib -ls to the bytecode linking options and -cclib -ls to the native linking options.

style_tags () is the current tag style used by Assemblage.Fmt.pp_styled.

symlink has an action action src dst that links src to dst using Assemblage.Acmd.ln_rel.

target_arch is the hardware architecture of the target machine (defaults to the value of Assemblage.Conf.host_arch).

target_os is the operating system name of the target machine (defaults to the value of Assemblage.Conf.host_os).

target_word_size is the target machine word bit size (defaults to the value of Assemblage.Conf.host_word_size).

temp suffix creates a temporary file with suffix suffix and returns its name.

test is true iff test build products should be built (defaults to false).

thread is the -thread flag in the right `OCaml contexts.

to_abs p is Some a if p is an absolute path.

to_cmd ext bin is an action command for using the part's binary.

to_cmd_path ext bin is to_cmd ext bin as a path.

to_rel p is Some r if p is a relative path.

to_segs a is a's segments.

to_segs r is r's segments.

to_segs p is p's segments.

to_string m is m as a string.

to_string m is m as a string.

to_string meta is m as a string.

to_string i is i as a string.

See Assemblage.Path.to_string.

See Assemblage.Path.to_string.

to_string p is the path p as a string according to the driver's platform convention with Filename.dir_sep.

tokens s is the list of non empty strings made of characters that are not separated by ' ', '\t', '\n', '\r' characters in s, the order of character appearance in the list is the same as in s.

tokens s is the list of non empty strings made of characters that are not separated by ' ', '\t', '\n', '\r' characters in s, the order of character appearance in the list is the same as in s.

true_ is const true.

ui ~docs is a Cmdliner term that defines a loader setting value either through command line options or through environment variables.

ui ~docs is a Cmdliner term that defines a library preferences value either through command line options or through environment variables (see Assemblage_driver.Lib_prefs.man_vars).

ui c is a Cmdliner term that allows to set the value of the public configuration keys of c using flags on the command line.

uname is the uname utility (defaults to "uname").

uniquify ss is ss without duplicates, the list order is preserved.

uniquify ss is ss without duplicates, the list order is preserved.

See Assemblage.Unit.v.

usage p is p's usage.

utf8_enabled () is true if UTF-8 pretty-printing is enabled.

v exists args parts n is the project named n with parts parts.

v dir name action is a run that executes the action action.

v spec install kind needs is a directory of type kind that gathers the products of existing needs as determined by the directory specifier spec.

v keep name kind needs is a documentation set named name of the given kind.

v opt name kind is a package named name of the given kind.

v ?byte ?native ?js name kind needs is a binary named name of the given kind.

v ?byte ?native ?native_dynlink name kind needs is a library named name of the given kind.

v ~needs ~dir name kind is a compilation unit named name, the name of the file without the suffix located in directory dir (defaults to Assemblage.root) of kind kind.

v ?usage ?exists ?meta ?needs ?args ?actions ?check name defines a base part named name.

v ctx inputs outputs cmds is the action that given the existence of inputs creates outputs using the sequence of command cmds.

v cmd args represents the execution of program cmd with argument args and standard file descriptors redirected to stdin, stdout, and stderr (if specified).

v ~exists ctx args is the bundle that binds ctx to args whenever exists evaluates to true (defaults to Assemblage.Conf.true_).

v els is the context with elements els.

value k is a value that evaluates to k's binding in the configuration.

vc ~exists ctx args is v ~exists ctx (Conf.const args).

version p evaluates Assemblage.Conf.project_version

version converts values of the form [v|V]major.minor[.patch][(-|+).*].

vmthread is the -vmthread flag in the right `OCaml contexts.

warn fmt ... logs a message with level Warning.

warn_count () is the number of messages logged with level Warning.

warn_error is true iff tools in general should treat warnings as errors (defaults to false).

watermark_string suffix p is a watermark that can be used in the comments of generated files for the project.

with_bin dir ext bin cmds is a run that executes the sequence of commands Conf.(cmds $ Bin.of_cmd ext bin).

with_conf p c is p with configuration c.

with_inf f inf v opens inf as a channel ic and returns f ic v if no error occurs.

with_inf f outf v opens outf as a channel oc and returns f oc v if no error occurs.

wrap o is o as an optional value.

write file content outputs content to file.

write cmd args file execute cmd with arguments args and writes the invocation's stdout to file.

write_lines file lines outputs lines separated by '\n' to file.

write_subst vars file content outputs content to file.