diff options
| author | Olivier Nicole <olivier@chnik.fr> | 2022-08-26 16:00:01 +0200 |
|---|---|---|
| committer | Olivier Nicole <olivier@chnik.fr> | 2023-01-17 13:46:22 +0100 |
| commit | f1ec4f2e62e026b84021e599cca3f546a3a66f9e (patch) | |
| tree | acaf6f2ae179be1ea3cf2c3bdc4f5d28f67dac22 /ocamltest/ocamltest.org | |
| parent | 41b01dc9c04256489f62d9ce1042cc354191c666 (diff) | |
| download | ocaml-f1ec4f2e62e026b84021e599cca3f546a3a66f9e.tar.gz | |
Document ocamltest variables and actions, document set and unset
* Add a brief description of each ocamltest test and “action”.
* Mention in the manual that these descriptions are printed by the
`-show-tests` (resp. `-show-variables`) option.
* Document setting and unsetting environment variable in ocamltest
Diffstat (limited to 'ocamltest/ocamltest.org')
| -rw-r--r-- | ocamltest/ocamltest.org | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/ocamltest/ocamltest.org b/ocamltest/ocamltest.org index e1c3fa70fa..bcee038b1d 100644 --- a/ocamltest/ocamltest.org +++ b/ocamltest/ocamltest.org @@ -604,8 +604,9 @@ baz = "hij" ** Other useful tests This section introduces three tests provided by =ocamltest= and that can -be of particular interest. A complete list of available tests and -actions and their detailed descriptions are given in chapters +be of particular interest. A brief description of each available test is shown +by the option `-show-tests` of ocamltest. A complete list of available tests +and actions and their detailed descriptions are given in chapters [[#builtins]] and [[#ocaml-specific]]. *** Testing the top-level: the =toplevel= and =expect= tests @@ -711,13 +712,34 @@ output: ** Variables, environments and how they are inherited +** Builtin variables + +The list of builtin variables can be obtained by running =ocamltest +-show-variables=. + ** Environment modifiers +Environment variables for a test can be set using: +#+begin_src +set VARIABLE_NAME="value" +#+end_src +in the test header (the quotes are mandatory). + +On the contrary, you can ensure that an environment variable is not set when +the test runs with: +#+begin_src +unset VARIABLE_NAME +#+end_src + * Built-in actions and tests :PROPERTIES: :CUSTOM_ID: builtins :END: +The list of builtin and OCaml-specific actions and tests can be obtained by +running =ocamltest -show-actions=. + + * OCaml-specific actions and tests :PROPERTIES: :CUSTOM_ID: ocaml-specific |