summaryrefslogtreecommitdiff
path: root/docs/yaml/functions/run_target.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/run_target.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/run_target.yaml')
-rw-r--r--docs/yaml/functions/run_target.yaml12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/yaml/functions/run_target.yaml b/docs/yaml/functions/run_target.yaml
index 3ede1c91e..bf670d8d2 100644
--- a/docs/yaml/functions/run_target.yaml
+++ b/docs/yaml/functions/run_target.yaml
@@ -31,25 +31,25 @@ posargs:
kwargs:
command:
- type: list[exe| external_program | custom_tgt | file | str]
+ type: array[exe| external_program | custom_tgt | file | str]
description: |
- A list containing the command to run and the arguments
- to pass to it. Each list item may be a string or a target. For
+ An array containing the command to run and the arguments
+ to pass to it. Each array element may be a string or a target. For
instance, passing the return value of [[executable]]
as the first item will run that executable, or passing a string as
the first item will find that command in `PATH` and run it.
depends:
- type: list[build_tgt | custom_tgt | custom_idx]
+ type: array[build_tgt | custom_tgt | custom_idx]
description: |
- A list of targets that this target depends on but which
+ An array of targets that this target depends on but which
are not listed in the command array (because, for example, the
script does file globbing internally, custom_idx was not possible
as a type between 0.60 and 1.4.0).
env:
since: 0.57.0
- type: env | list[str] | dict[str]
+ type: env | array[str] | dict[str]
description: |
environment variables to set, such as
`{'NAME1': 'value1', 'NAME2': 'value2'}` or `['NAME1=value1', 'NAME2=value2']`,