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
pull/10854/head
Eli Schwartz 2 years ago
parent 2d349eae8c
commit dcc50b9967
No known key found for this signature in database
GPG Key ID: CEB167EFB5722BD6
  1. 14
      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:

Loading…
Cancel
Save