aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Contributing.md
diff options
context:
space:
mode:
authorDaniel Mensinger <daniel@mensinger-ka.de>2020-04-05 18:52:28 +0200
committerDaniel Mensinger <daniel@mensinger-ka.de>2020-04-28 17:54:02 +0200
commit4640f13faa899a2de58ef4d835605f53b46550f3 (patch)
tree8a4acd5bcaac6333655470c36d22caf3f151c326 /docs/markdown/Contributing.md
parent76c36a64c3e55692f5d37b1f1762fac448e845bd (diff)
downloadmeson-4640f13faa899a2de58ef4d835605f53b46550f3.zip
meson-4640f13faa899a2de58ef4d835605f53b46550f3.tar.gz
meson-4640f13faa899a2de58ef4d835605f53b46550f3.tar.bz2
docs: Fix Contributing.md
Diffstat (limited to 'docs/markdown/Contributing.md')
-rw-r--r--docs/markdown/Contributing.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md
index 5332938..554c3f5 100644
--- a/docs/markdown/Contributing.md
+++ b/docs/markdown/Contributing.md
@@ -174,7 +174,7 @@ contents of an additional file into the CI log on failure.
Projects needed by unit tests are in the `test cases/unit`
subdirectory. They are not run as part of `./run_project_tests.py`.
-#### Configuring project tests
+### Configuring project tests
The (optional) `test.json` file, in the root of a test case, is used
for configuring the test. All of the following root entries in the `test.json`
@@ -213,13 +213,13 @@ Exanple `test.json`:
}
```
-##### env
+#### env
The `env` key contains a dictionary which specifies additional
environment variables to be set during the configure step of the test. `@ROOT@`
is replaced with the absolute path of the source directory.
-##### installed
+#### installed
The `installed` dict contains a list of dicts, describing which files are expected
to be installed. Each dict contains the following keys:
@@ -277,7 +277,7 @@ the platform matches. The following values for `platform` are currently supporte
| `cygwin` | Matches when the platform is cygwin |
| `!cygwin` | Not `cygwin` |
-##### matrix
+#### matrix
The `matrix` section can be used to define a test matrix to run project tests
with different meson options.
@@ -318,7 +318,7 @@ The above example will produce the following matrix entries:
- `opt1=qwert`
- `opt1=qwert opt2=true`
-##### do_not_set_opts
+#### do_not_set_opts
Currently supported values are:
- `prefix`