diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2022-11-30 18:17:33 -0500 |
|---|---|---|
| committer | Eli Schwartz <eschwartz@archlinux.org> | 2022-11-30 18:26:59 -0500 |
| commit | dcc50b9967b96da371412867b385811eb57f0497 (patch) | |
| tree | 6655e8ef190fe624cee6a1a318e441cc408972bf | |
| parent | 2d349eae8cb6f1f3b61838dca7cc989e9278be28 (diff) | |
| download | meson-dcc50b9967b96da371412867b385811eb57f0497.zip meson-dcc50b9967b96da371412867b385811eb57f0497.tar.gz meson-dcc50b9967b96da371412867b385811eb57f0497.tar.bz2 | |
docs: clarify that prog.full_path has potentially valid uses
Claiming that "it should literally never be used ever no matter what" is
confusing and wrong -- it's definitely useful sometimes, but does result
in downsides, like not tracking inter-target dependencies correctly.
Ref: #10901
| -rw-r--r-- | docs/yaml/objects/external_program.yaml | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/yaml/objects/external_program.yaml b/docs/yaml/objects/external_program.yaml index f406477..923cb54 100644 --- a/docs/yaml/objects/external_program.yaml +++ b/docs/yaml/objects/external_program.yaml @@ -15,8 +15,11 @@ methods: 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. + **NOTE:** You should not usually need to use this method. Passing the + object itself should work in most contexts where a program can appear, + and allows Meson to setup inter-target dependencies correctly. Only + use this if you specifically need a string, such as when embedding a + program path into a header file. For example: @@ -38,8 +41,11 @@ methods: 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. + **NOTE:** You should not usually need to use this method. Passing the + object itself should work in most contexts where a program can appear, + and allows Meson to setup inter-target dependencies correctly. Only + use this if you specifically need a string, such as when embedding a + program path into a header file. For example: |