aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/items/probe/path-probe.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/items/probe/path-probe.qdoc')
-rw-r--r--doc/reference/items/probe/path-probe.qdoc20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/reference/items/probe/path-probe.qdoc b/doc/reference/items/probe/path-probe.qdoc
index eaaee9e54..936ce3180 100644
--- a/doc/reference/items/probe/path-probe.qdoc
+++ b/doc/reference/items/probe/path-probe.qdoc
@@ -81,7 +81,7 @@
For example, when searching for a library, it might be necessary to check its architecture:
\code
PathProbe {
- pathSuffixes: ["*.so", *.dll]
+ pathSuffixes: [".so", ".dll", ".dylib"]
candidateFilter: {
function getLibraryArchitecture(file) { ... }
return function(file) {
@@ -169,6 +169,24 @@
This property contains the result list of all paths that were checked before a file was found
(including the file names).
+ This property is set even if the Probe didn't find anything and can be used to give the user
+ a hint what went wrong:
+ \code
+ Module {
+ Probes.BinaryProbe {
+ id: pythonProbe
+ names: "python"
+ }
+ validate: {
+ if (!pythonProbe.found) {
+ throw ModUtils.ModuleError(
+ "Could not find python binary at any of the following locations:\n\t" +
+ pythonProbe.candidatePaths.join("\n\t"));
+ }
+ }
+ }
+ \endcode
+
\nodefaultvalue
*/