diff options
author | Ivan Komissarov <abbapoh@gmail.com> | 2020-08-10 22:22:35 +0200 |
---|---|---|
committer | Ivan Komissarov <ABBAPOH@gmail.com> | 2020-08-13 17:59:29 +0000 |
commit | a15e25ac5d5888d9e2dde13df0b7b21a37ba4e56 (patch) | |
tree | c07f9c63e83e832fc536304bde5db98b36d7c21e /doc | |
parent | d03135c9509821270c541fe0725d7365c7a19d55 (diff) |
Tune search order of path probes
Within the groups of user-provided and system-provided paths,
environment variables need to take precedence over properties, because
there is currently no other way to override the search paths of probes
from the outside if the probe-using code did not explicitly bind them to
Product/Module properties.
We search directly user-provided paths before ones from system-provided
environment variables to minimize the risk of surprises due to outside
influence.
[ChangeLog][Behavior Changes] The lookup order in PathProbe changed to
[environmentPaths, searchPaths, platformEnvironmentPaths,
platformSearchPaths]
Change-Id: Ib0c3bc44e5a8efaaaa073f28f1f3a53feb0f78db
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/items/probe/path-probe.qdoc | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/reference/items/probe/path-probe.qdoc b/doc/reference/items/probe/path-probe.qdoc index df5fbb22f..b7749f09d 100644 --- a/doc/reference/items/probe/path-probe.qdoc +++ b/doc/reference/items/probe/path-probe.qdoc @@ -37,10 +37,11 @@ locations. PathProbe takes as input lists of paths to search files from and file name patterns. The paths - are specified by using the searchPaths, platformSearchPaths, environmentPaths, and - platformEnvironmentPaths properties. The file name patterns are specified by the \l names and - nameSuffixes properties. Returns the first file that matches the file name patterns. If no such - file is found, the \l {Probe::found}{probe.found} property is set to \c false. + are specified by using the environmentPaths, searchPaths, platformEnvironmentPaths and + platformSearchPaths properties; the path are searched in the same order as listed. The file + name patterns are specified by the \l names and nameSuffixes properties. Returns the first file + that matches the file name patterns. If no such file is found, the + \l {Probe::found}{probe.found} property is set to \c false. For example, a simple PathProbe that searches for the stdio.h header can be used as follows: |