ppx_inline_test Last updated Mar 18, 2025
ppx_inline_test
load("@rules_ppx//build:rules.bzl", "ppx_inline_test")
ppx_inline_test(*, name, data, cc_deps, cc_libs, cc_linkall, cc_linkopts, compatible_with, data_prefix_map, deprecation, diff_cmd, env, epilogue, exe_name, exec_compatible_with, exec_properties, features, flaky, force_archived_libdeps, local, opts, package_metadata, prologue, restricted_to, runtime, shard_count, size, tags, target_compatible_with, testonly, testsuites, timeout, toolchains, visibility, vm_linkage)
ppx inline test doc…
Attributes
Name | Description | Type | Mandatory | Default |
---|---|---|---|---|
A unique name for this macro instance. Normally, this is also the name for the macro's main or only target. The names of any other targets that this macro might create will be this name with a string suffix. |
required |
|||
Runtime dependencies: list of labels of data files needed by this executable at runtime. |
optional |
|
||
Dictionary specifying C/C++ library dependencies. Key: a target label; value: a linkmode string, which determines which file to link. Valid linkmodes: 'default', 'static', 'dynamic', 'shared' (synonym for 'dynamic'). For more information see [CC Dependencies: Linkmode](../ug/cc_deps.md#linkmode). |
optional |
|
||
- |
optional |
|
||
True: use `-whole-archive` (GCC toolchain) or `-force_load` (Clang toolchain). Deps in this attribute must also be listed in cc_deps. |
optional |
|
||
List of C/C++ link options. E.g. ["-lstd++"]. |
List of strings |
optional |
|
|
optional |
|
|||
Map for replacing path prefixes of data files |
optional |
|
||
String; nonconfigurable |
optional |
|
||
- |
optional |
|
||
Env variables |
optional |
|
||
List of OCaml dependencies to be linked after `main`. |
optional |
|
||
By default, executable name is derived from 'name' attribute; use this to override. |
String |
optional |
|
|
optional |
|
|||
optional |
|
|||
List of strings |
optional |
|
||
Boolean; nonconfigurable |
optional |
|
||
Force archiving of library dependencies |
Boolean |
optional |
|
|
Boolean; nonconfigurable |
optional |
|
||
List of compile options; overrides configurable default options. Supports `+-no-+` prefix for each option; for example, `-no-linkall`. |
List of strings |
optional |
|
|
optional |
|
|||
List of OCaml dependencies to be linked before `main`. |
optional |
|
||
optional |
|
|||
Runtime to use. One of @rules_ocaml//rt:std, @rules_ocaml//rt:dbg, @rules_ocaml//rt:instrumented; or, label of an `ocaml_runtime` target creating a custom runtime. |
optional |
|
||
Integer |
optional |
|
||
String; nonconfigurable |
optional |
|
||
List of strings; nonconfigurable |
optional |
|
||
optional |
|
|||
Boolean; nonconfigurable |
optional |
|
||
testsuites ... |
List of strings; nonconfigurable |
required |
||
String; nonconfigurable |
optional |
|
||
optional |
|
|||
The visibility to be passed to this macro's exported targets. It always implicitly includes the location where this macro is instantiated, so this attribute only needs to be explicitly set if you want the macro's targets to be additionally visible somewhere else. |
optional |
|||
custom, dynamic or static. Custom means link with -custom flag; static with -output-complete-exe |
String |
optional |
|