diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-01 16:37:02 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:38 (GMT) |
| commit | 898216137a184940867a1678b07ca8470b2d7b85 (patch) | |
| tree | 9609a6314708675177dfe3c48ba19f64f0b8e640 /Help/command/FIND_XXX_ORDER.txt | |
| parent | 30b21860adaefa7493262c41f0b95b4065d46aa3 (diff) | |
| download | CMake-898216137a184940867a1678b07ca8470b2d7b85.zip CMake-898216137a184940867a1678b07ca8470b2d7b85.tar.gz CMake-898216137a184940867a1678b07ca8470b2d7b85.tar.bz2 | |
Help: Factor out find_* command duplication
These documents were represented in the builtin documentation using a
common starting point with placeholders substituted by each command.
Convert them back to this approach using the reStructuredText include
directive and substitutions to avoid duplication.
Diffstat (limited to 'Help/command/FIND_XXX_ORDER.txt')
| -rw-r--r-- | Help/command/FIND_XXX_ORDER.txt | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/command/FIND_XXX_ORDER.txt b/Help/command/FIND_XXX_ORDER.txt new file mode 100644 index 0000000..bac2419 --- /dev/null +++ b/Help/command/FIND_XXX_ORDER.txt @@ -0,0 +1,12 @@ +The default search order is designed to be most-specific to +least-specific for common use cases. +Projects may override the order by simply calling the command +multiple times and using the ``NO_*`` options: + +.. parsed-literal:: + + |FIND_XXX| (|FIND_ARGS_XXX| PATHS paths... NO_DEFAULT_PATH) + |FIND_XXX| (|FIND_ARGS_XXX|) + +Once one of the calls succeeds the result variable will be set +and stored in the cache so that no call will search again. |