Skip to content

Commit 6ad6658

Browse files
committed
rename ExternalProgram object to Program
This matches the Python class name, which shows up in errors, and is simpler. Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 984d846 commit 6ad6658

18 files changed

+39
-40
lines changed

docs/markdown/Python-3-module.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ This module is deprecated and replaced by the
99
## find_python
1010

1111
This is a cross platform way of finding the Python 3 executable, which
12-
may have a different name on different operating systems. Returns an
13-
[[@external_program]]
14-
object.
12+
may have a different name on different operating systems. Returns a
13+
[[@program]] object.
1514

1615
*Added 0.38.0*
1716

docs/markdown/Python-module.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Keyword arguments are the following:
7676

7777
## `python_installation` object
7878

79-
The `python_installation` object is an [[@external_program]], with several
79+
The `python_installation` object is an [[@program]], with several
8080
added methods.
8181

8282
### Methods
@@ -91,7 +91,7 @@ str py_installation.path()
9191

9292
*Deprecated in 0.55: use `full_path()` instead*
9393

94-
Works like the path method of `ExternalProgram` objects. Was not provided prior
94+
Works like the path method of `Program` objects. Was not provided prior
9595
to 0.50.0 due to a bug.
9696

9797
#### `full_path()`
@@ -102,7 +102,7 @@ str py_installation.full_path()
102102

103103
*(since 0.55.0)*
104104

105-
Works like the `full_path()` method of `ExternalProgram` objects: [[external_program.full_path]]
105+
Works like the `full_path()` method of `Program` objects: [[program.full_path]]
106106

107107
#### `extension_module()`
108108

docs/markdown/Release-notes-for-0.59.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ executable(
197197

198198
The [[@build_tgt]] object now supports
199199
the following two functions, to ensure feature compatibility with
200-
[[@external_program]] objects:
200+
[[@program]] objects:
201201

202202
- `found()`: Always returns `true`. This function is meant
203203
to make executables objects feature compatible with

docs/yaml/builtins/meson.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ methods:
4545
4646
posargs:
4747
script_name:
48-
type: str | file | external_program
48+
type: str | file | program
4949
description: |
5050
The script to execute.
5151
@@ -55,7 +55,7 @@ methods:
5555
5656
varargs:
5757
name: arg
58-
type: str | file | external_program
58+
type: str | file | program
5959
since: 0.49.0
6060
description: |
6161
Additional arguments
@@ -102,7 +102,7 @@ methods:
102102
103103
posargs:
104104
script_name:
105-
type: str | file | external_program | exe | custom_tgt | custom_idx
105+
type: str | file | program | exe | custom_tgt | custom_idx
106106
description: |
107107
The script to execute.
108108
@@ -113,7 +113,7 @@ methods:
113113
114114
varargs:
115115
name: arg
116-
type: str | file | external_program | exe | custom_tgt | custom_idx
116+
type: str | file | program | exe | custom_tgt | custom_idx
117117
since: 0.49.0
118118
description: |
119119
Additional arguments
@@ -389,7 +389,7 @@ methods:
389389
description: The name of the program to override.
390390

391391
program:
392-
type: exe | file | external_program
392+
type: exe | file | program
393393
description: The program to set as the override for `progname`.
394394

395395
- name: override_dependency

docs/yaml/functions/add_test_setup.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ kwargs:
2626
environment juggling. *(Since 0.52.0)* A dictionary is also accepted.
2727
2828
exe_wrapper:
29-
type: array[str | external_program]
29+
type: array[str | program]
3030
description: The command or script followed by the arguments to it
3131

3232
gdb:

docs/yaml/functions/benchmark.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ posargs:
2222
description: The *unique* test id
2323

2424
executable:
25-
type: exe | jar | external_program | file | custom_tgt | custom_idx
25+
type: exe | jar | program | file | custom_tgt | custom_idx
2626
description: |
2727
The program to execute. *(Since 1.4.0)* A CustomTarget is also accepted.
2828
2929
kwargs:
3030
args:
31-
type: array[str | file | tgt | external_program]
31+
type: array[str | file | tgt | program]
3232
description: Arguments to pass to the executable
3333

3434
env:

docs/yaml/functions/custom_target.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ kwargs:
124124
serializing all targets in this pool.
125125
126126
command:
127-
type: array[str | file | exe | external_program]
127+
type: array[str | file | exe | program]
128128
description: |
129129
Command to run to create outputs from inputs. The command
130130
may be strings or the return value of functions that return file-like

docs/yaml/functions/find_program.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: find_program
2-
returns: external_program
2+
returns: program
33
description: |
44
`program_name` here is a string that can be an executable or script
55
to be searched for in `PATH` or other places inside the project.
@@ -45,7 +45,7 @@ description: |
4545
*Since 1.2.0* `find_program('meson')` is automatically overridden to the Meson
4646
command used to execute the build script.
4747
48-
The returned [[@external_program]] object also has documented methods.
48+
The returned [[@program]] object also has documented methods.
4949
5050
posargs:
5151
program_name:
@@ -73,7 +73,7 @@ kwargs:
7373
When `true`, Meson will abort if no program can be found.
7474
If `required` is set to `false`,
7575
Meson continue even if none of the programs can be found. You can
76-
then use the `.found()` method on the returned [[@external_program]] to check
76+
then use the `.found()` method on the returned [[@program]] to check
7777
whether it was found or not. *(since 0.47.0)* The value of a
7878
[`feature`](Build-options.md#features) option can also be passed to the
7979
`required` keyword argument.

docs/yaml/functions/generator.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ description: |
4040
4141
posargs:
4242
exe:
43-
type: exe | external_program
43+
type: exe | program
4444
description: Executable for the command to run
4545

4646
kwargs:

docs/yaml/functions/run_command.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: |
1717
1818
varargs:
1919
name: command
20-
type: str | file | external_program
20+
type: str | file | program
2121
description: The command to execute during the setup process.
2222

2323
kwargs:

0 commit comments

Comments
 (0)