mirror of
https://github.com/mesonbuild/meson.git
synced 2026-08-09 09:12:24 +00:00
30bab71b1d
This matches the Python class name, which shows up in errors, and is simpler. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
64 lines
1.9 KiB
YAML
64 lines
1.9 KiB
YAML
name: program
|
|
long_name: External program
|
|
description: Opaque object representing an external program
|
|
|
|
methods:
|
|
- name: found
|
|
returns: bool
|
|
description: Returns whether the executable was found.
|
|
|
|
- name: path
|
|
returns: str
|
|
deprecated: 0.55.0
|
|
description: |
|
|
*Deprecated:* Use [[program.full_path]] instead.
|
|
|
|
Returns a string pointing to the script or executable.
|
|
|
|
**NOTE:** You should not usually need to use this method. Passing the
|
|
object itself should work in most contexts where a program can appear,
|
|
and allows Meson to setup inter-target dependencies correctly (for
|
|
example in cases where a program might be overridden by a [[@build_tgt]]).
|
|
Only use this if you specifically need a string, such as when embedding
|
|
a program path into a header file, or storing it into an environment
|
|
variable.
|
|
|
|
For example:
|
|
|
|
```meson
|
|
run_command(find_program('foo'), 'arg1', 'arg2')
|
|
```
|
|
|
|
- name: version
|
|
returns: str
|
|
since: 0.62.0
|
|
description: |
|
|
The version number as a string, for example `1.2.8`.
|
|
|
|
`unknown` if the program cannot determine the version via a `--version` argument.
|
|
|
|
- name: full_path
|
|
returns: str
|
|
since: 0.55.0
|
|
description: |
|
|
Returns a string pointing to the script or executable.
|
|
|
|
**NOTE:** You should not usually need to use this method. Passing the
|
|
object itself should work in most contexts where a program can appear,
|
|
and allows Meson to setup inter-target dependencies correctly (for
|
|
example in cases where a program might be overridden by a [[@build_tgt]]).
|
|
Only use this if you specifically need a string, such as when embedding
|
|
a program path into a header file, or storing it into an environment
|
|
variable.
|
|
|
|
For example:
|
|
|
|
```meson
|
|
run_command(find_program('foo'), 'arg1', 'arg2')
|
|
```
|
|
|
|
- name: cmd_array
|
|
returns: array[str]
|
|
description: Returns an array containing the command(s) for the program.
|
|
since: 1.10.0
|