aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml/objects/external_program.yaml
blob: f4064771db3c11dfad5bf682e23ee630b02d4385 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
name: external_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 [[external_program.full_path]] instead.

    Returns a string pointing to the script or executable.

    **NOTE:** You should not need to use this method. Passing the object itself
    should work in all cases.

    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 need to use this method. Passing the object itself
    should work in all cases.

    For example:

    ```meson
    run_command(find_program('foo'), 'arg1', 'arg2')
    ```