summaryrefslogtreecommitdiff
path: root/docs/yaml/functions/benchmark.yaml
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2025-07-19 21:50:09 -0700
committerDylan Baker <dylan@pnwbakers.com>2025-07-22 09:05:22 -0700
commit092ab8c9e117cc00aa699c8d513572f95009cae8 (patch)
treef1423cd24212df161a9c45247d3cf78e87737659 /docs/yaml/functions/benchmark.yaml
parent2b7661a43f8e85d666dd66ecddb85aedb154a58c (diff)
downloadmeson-092ab8c9e117cc00aa699c8d513572f95009cae8.tar.gz
Docs: standardize between list and array as array
When arrays were added they were called arrays. Because the are implemented with Python lists, that language started leaking into talking about Meson types. This is confusing. I've attempted, as much as possible, to move to using one name, array. I picked array because 1) It's the original name used, and 2) what Meson has are more properly arrays as they have a fixed length, while a critical property of lists are the ability to link and unlink them. There are a couple of places where the list language has leaked into the names of keyword arguments. I have not made any attempt to change those, I don't know if it's that useful or not.
Diffstat (limited to 'docs/yaml/functions/benchmark.yaml')
-rw-r--r--docs/yaml/functions/benchmark.yaml12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/yaml/functions/benchmark.yaml b/docs/yaml/functions/benchmark.yaml
index 7a555a42d..fe69f28fd 100644
--- a/docs/yaml/functions/benchmark.yaml
+++ b/docs/yaml/functions/benchmark.yaml
@@ -28,11 +28,11 @@ posargs:
kwargs:
args:
- type: list[str | file | tgt | external_program]
+ type: array[str | file | tgt | external_program]
description: Arguments to pass to the executable
env:
- type: env | list[str] | dict[str]
+ type: env | array[str] | dict[str]
description: |
environment variables to set, such as `['NAME1=value1',
'NAME2=value2']`, or an [[@env]] object which allows more sophisticated
@@ -46,11 +46,11 @@ kwargs:
executable returns a non-zero return value (i.e. reports an error)
suite:
- type: str | list[str]
+ type: str | array[str]
description: |
- `'label'` (or list of labels `['label1', 'label2']`)
+ `'label'` (or array of labels `['label1', 'label2']`)
attached to this test. The suite name is qualified by a (sub)project
- name resulting in `(sub)project_name:label`. In the case of a list
+ name resulting in `(sub)project_name:label`. In the case of an array
of strings, the suite names will be `(sub)project_name:label1`,
`(sub)project_name:label2`, etc.
@@ -70,7 +70,7 @@ kwargs:
for the test
depends:
- type: list[build_tgt | custom_tgt]
+ type: array[build_tgt | custom_tgt]
since: 0.46.0
description: |
specifies that this test depends on the specified