From b672ebca886dd6dc9b0f775eb769764750fd302c Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Mon, 4 Oct 2021 19:39:36 +0200 Subject: Minor fixups --- docs/yaml/builtins/host_machine.yaml | 1 + docs/yaml/builtins/target_machine.yaml | 1 + docs/yaml/objects/build_tgt.yaml | 2 -- docs/yaml/objects/external_program.yaml | 39 ++++++++++++++++++++++++++++++++- 4 files changed, 40 insertions(+), 3 deletions(-) (limited to 'docs/yaml') 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') + ``` -- cgit v1.2.3