diff options
| author | Daniel Mensinger <daniel@mensinger-ka.de> | 2021-10-04 19:39:36 +0200 |
|---|---|---|
| committer | Daniel Mensinger <daniel@mensinger-ka.de> | 2021-10-04 19:39:36 +0200 |
| commit | b672ebca886dd6dc9b0f775eb769764750fd302c (patch) | |
| tree | 342bc608e79ed7a248ca849b77d52ff63dbdab8b /docs/yaml | |
| parent | 0b9c7b74bef2dd5913cc8d96de0fc016d682ead1 (diff) | |
| download | meson-b672ebca886dd6dc9b0f775eb769764750fd302c.tar.gz | |
Minor fixups
Diffstat (limited to 'docs/yaml')
| -rw-r--r-- | docs/yaml/builtins/host_machine.yaml | 1 | ||||
| -rw-r--r-- | docs/yaml/builtins/target_machine.yaml | 1 | ||||
| -rw-r--r-- | docs/yaml/objects/build_tgt.yaml | 2 | ||||
| -rw-r--r-- | docs/yaml/objects/external_program.yaml | 39 |
4 files changed, 40 insertions, 3 deletions
diff --git a/docs/yaml/builtins/host_machine.yaml b/docs/yaml/builtins/host_machine.yaml index f13058632..2c847b523 100644 --- a/docs/yaml/builtins/host_machine.yaml +++ b/docs/yaml/builtins/host_machine.yaml @@ -1,5 +1,6 @@ name: host_machine long_name: Host machine information +extends: build_machine description: | Provides information about the host machine -- the machine on which the compiled binary will run. See diff --git a/docs/yaml/builtins/target_machine.yaml b/docs/yaml/builtins/target_machine.yaml index d5c4e4d49..c17adc792 100644 --- a/docs/yaml/builtins/target_machine.yaml +++ b/docs/yaml/builtins/target_machine.yaml @@ -1,5 +1,6 @@ name: target_machine long_name: Target machine information +extends: build_machine description: | Provides information about the target machine -- the machine on which the compiled binary's output will run. Hence, this object should only diff --git a/docs/yaml/objects/build_tgt.yaml b/docs/yaml/objects/build_tgt.yaml index e1c8a8002..97c0c5d3e 100644 --- a/docs/yaml/objects/build_tgt.yaml +++ b/docs/yaml/objects/build_tgt.yaml @@ -5,8 +5,6 @@ description: | A build target is either an executable, shared library, static library, both shared and static library or shared module. - TODO: Missing methods, links - methods: - name: full_path returns: str diff --git a/docs/yaml/objects/external_program.yaml b/docs/yaml/objects/external_program.yaml index d0e476f5d..02bf48f6b 100644 --- a/docs/yaml/objects/external_program.yaml +++ b/docs/yaml/objects/external_program.yaml @@ -1,3 +1,40 @@ name: external_program long_name: External program -description: TODO +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: 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') + ``` |