Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/markdown/Python-3-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ This module is deprecated and replaced by the
## find_python

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

*Added 0.38.0*

Expand Down
6 changes: 3 additions & 3 deletions docs/markdown/Python-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Keyword arguments are the following:

## `python_installation` object

The `python_installation` object is an [[@external_program]], with several
The `python_installation` object is an [[@program]], with several
added methods.

### Methods
Expand All @@ -91,7 +91,7 @@ str py_installation.path()

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

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

#### `full_path()`
Expand All @@ -102,7 +102,7 @@ str py_installation.full_path()

*(since 0.55.0)*

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

#### `extension_module()`

Expand Down
2 changes: 1 addition & 1 deletion docs/markdown/Release-notes-for-0.59.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ executable(

The [[@build_tgt]] object now supports
the following two functions, to ensure feature compatibility with
[[@external_program]] objects:
[[@program]] objects:

- `found()`: Always returns `true`. This function is meant
to make executables objects feature compatible with
Expand Down
10 changes: 5 additions & 5 deletions docs/yaml/builtins/meson.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ methods:

posargs:
script_name:
type: str | file | external_program
type: str | file | program
description: |
The script to execute.

Expand All @@ -55,7 +55,7 @@ methods:

varargs:
name: arg
type: str | file | external_program
type: str | file | program
since: 0.49.0
description: |
Additional arguments
Expand Down Expand Up @@ -102,7 +102,7 @@ methods:

posargs:
script_name:
type: str | file | external_program | exe | custom_tgt | custom_idx
type: str | file | program | exe | custom_tgt | custom_idx
description: |
The script to execute.

Expand All @@ -113,7 +113,7 @@ methods:

varargs:
name: arg
type: str | file | external_program | exe | custom_tgt | custom_idx
type: str | file | program | exe | custom_tgt | custom_idx
since: 0.49.0
description: |
Additional arguments
Expand Down Expand Up @@ -389,7 +389,7 @@ methods:
description: The name of the program to override.

program:
type: exe | file | external_program
type: exe | file | program
description: The program to set as the override for `progname`.

- name: override_dependency
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/add_test_setup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ kwargs:
environment juggling. *(Since 0.52.0)* A dictionary is also accepted.

exe_wrapper:
type: array[str | external_program]
type: array[str | program]
description: The command or script followed by the arguments to it

gdb:
Expand Down
4 changes: 2 additions & 2 deletions docs/yaml/functions/benchmark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ posargs:
description: The *unique* test id

executable:
type: exe | jar | external_program | file | custom_tgt | custom_idx
type: exe | jar | program | file | custom_tgt | custom_idx
description: |
The program to execute. *(Since 1.4.0)* A CustomTarget is also accepted.

kwargs:
args:
type: array[str | file | tgt | external_program]
type: array[str | file | tgt | program]
description: Arguments to pass to the executable

env:
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/custom_target.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ kwargs:
serializing all targets in this pool.

command:
type: array[str | file | exe | external_program]
type: array[str | file | exe | program]
description: |
Command to run to create outputs from inputs. The command
may be strings or the return value of functions that return file-like
Expand Down
6 changes: 3 additions & 3 deletions docs/yaml/functions/find_program.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: find_program
returns: external_program
returns: program
description: |
`program_name` here is a string that can be an executable or script
to be searched for in `PATH` or other places inside the project.
Expand Down Expand Up @@ -45,7 +45,7 @@ description: |
*Since 1.2.0* `find_program('meson')` is automatically overridden to the Meson
command used to execute the build script.

The returned [[@external_program]] object also has documented methods.
The returned [[@program]] object also has documented methods.

posargs:
program_name:
Expand Down Expand Up @@ -73,7 +73,7 @@ kwargs:
When `true`, Meson will abort if no program can be found.
If `required` is set to `false`,
Meson continue even if none of the programs can be found. You can
then use the `.found()` method on the returned [[@external_program]] to check
then use the `.found()` method on the returned [[@program]] to check
whether it was found or not. *(since 0.47.0)* The value of a
[`feature`](Build-options.md#features) option can also be passed to the
`required` keyword argument.
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/generator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ description: |

posargs:
exe:
type: exe | external_program
type: exe | program
description: Executable for the command to run

kwargs:
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/run_command.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ description: |

varargs:
name: command
type: str | file | external_program
type: str | file | program
description: The command to execute during the setup process.

kwargs:
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/run_target.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ posargs:

kwargs:
command:
type: array[exe| external_program | custom_tgt | file | str]
type: array[exe| program | custom_tgt | file | str]
description: |
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
Expand Down
4 changes: 2 additions & 2 deletions docs/yaml/functions/summary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ arg_flattening: false

posargs:
key_or_dict:
type: str | dict[str | bool | int | dep | external_program | array[str | bool | int | dep | external_program]]
type: str | dict[str | bool | int | dep | program | array[str | bool | int | dep | program]]
description: |
The name of the new entry, or a dict containing multiple entries. If a
dict is passed it is equivalent to calling summary() once for each
Expand All @@ -74,7 +74,7 @@ posargs:

optargs:
value:
type: str | bool | int | dep | external_program | array[str | bool | int | dep | external_program]
type: str | bool | int | dep | program | array[str | bool | int | dep | program]
description: |
The value to print for the `key`. Only valid if `key_or_dict` is a str.

Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/functions/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: |
Defines a test to run with the test harness. Takes two positional
arguments, the first is the name of the test and the second is the
executable to run. The executable can be an [[@exe]] object returned by
[[executable]] or an [[@external_program]] object] returned by
[[executable]] or an [[@program]] object] returned by
[[find_program]].
*(since 0.55.0)* When cross compiling, if an exe_wrapper is needed and
Expand Down
4 changes: 2 additions & 2 deletions docs/yaml/functions/vcs_tag.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ description: |

kwargs:
command:
type: array[exe | external_program | custom_tgt | file | str]
type: array[exe | program | custom_tgt | file | str]
description: |
The command to execute, see [[custom_target]] for details
on how this command must be specified.
Expand All @@ -32,7 +32,7 @@ kwargs:

*(since 0.62.0)* [[@file]] is accepted.

*(since 0.63.0)* [[@custom_tgt]], [[@exe]], and [[@external_program]] are accepted.
*(since 0.63.0)* [[@custom_tgt]], [[@exe]], and [[@program]] are accepted.

input:
type: str
Expand Down
8 changes: 4 additions & 4 deletions docs/yaml/objects/build_tgt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ methods:
deprecated: 0.59.0
description: |
Does the exact same as [[build_tgt.full_path]]. **NOTE**: This
function is solely kept for compatibility with [[@external_program]] objects.
function is solely kept for compatibility with [[@program]] objects.
It will be removed once the, also deprecated, corresponding `path()`
function in the [[@external_program]] object is removed.
function in the [[@program]] object is removed.

- name: private_dir_include
returns: inc
Expand All @@ -74,9 +74,9 @@ methods:
since: 0.59.0
description: |
Always returns `true`. This function is meant to make executables
objects feature compatible with [[@external_program]] objects. This
objects feature compatible with [[@program]] objects. This
simplifies use-cases where an executable is used instead of
an [[@external_program]].
an [[@program]].

- name: vala_header
returns: file
Expand Down
4 changes: 2 additions & 2 deletions docs/yaml/objects/external_program.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: external_program
name: program
long_name: External program
description: Opaque object representing an external program

Expand All @@ -11,7 +11,7 @@ methods:
returns: str
deprecated: 0.55.0
description: |
*Deprecated:* Use [[external_program.full_path]] instead.
*Deprecated:* Use [[program.full_path]] instead.
Returns a string pointing to the script or executable.
Expand Down
Loading
Loading