aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2020-10-02 13:53:50 +0530
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2020-10-02 09:38:35 +0000
commit264939963f696cbf768b1d7c8011d72a8064323f (patch)
tree91dc91ba66c8de994f13ad3f039c4c6e93832730 /docs/markdown
parent32cf7a03d251e5a352e2cc2aa8ed4b95c6682bc0 (diff)
downloadmeson-264939963f696cbf768b1d7c8011d72a8064323f.zip
meson-264939963f696cbf768b1d7c8011d72a8064323f.tar.gz
meson-264939963f696cbf768b1d7c8011d72a8064323f.tar.bz2
docs: Fixup find_program search path documentation [skip ci]
It was slightly wrong, and also make it a bullet point for easier parsing.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 98b3233..8bff428 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -698,11 +698,22 @@ The returned object also has methods that are documented in the
```
`program_name1` here is a string that can be an executable or script
-to be searched for in `PATH`, or a script in the current source
-directory. The search order is: program overrides (set via meson.override_find_program());
-subprojects (if wrap_mode is set to `forcefallback`); your project's source tree;
-$PATH; the python3 libdir if your command starts with `python3` and finally
-subprojects again, if wrap_mode is set to anything but `nofallback`.
+to be searched for in `PATH` or other places inside the project.
+The search order is:
+
+1. Program overrides set via [`meson.override_find_program()`](Reference-manual.md#meson-object)
+1. [`[provide]` sections](Wrap-dependency-system-manual.md#provide-section)
+ in subproject wrap files, if [`wrap_mode`](Builtin-options.md#core-options) is
+ set to `forcefallback`
+1. [`[binaries]` section](Machine-files.md#binaries) in your machine files
+1. Directories provided using the `dirs:` kwarg (see below)
+1. Project's source tree relative to the current subdir
+ - If you use the return value of [`configure_file()`](#configure_file), the
+ current subdir inside the build tree is used instead
+1. `PATH` environment variable
+1. [`[provide]` sections](Wrap-dependency-system-manual.md#provide-section) in
+ subproject wrap files, if [`wrap_mode`](Builtin-options.md#core-options) is
+ set to anything other than `nofallback`
*(since 0.37.0)* `program_name2` and later positional arguments are used as fallback
strings to search for. This is meant to be used for cases where the