summaryrefslogtreecommitdiff
path: root/Help/command/FIND_XXX.txt
Commit message (Collapse)AuthorAgeFilesLines
* find_package: Use <PACKAGENAME>_ROOT variables as search prefixesBrad King2023-02-231-1/+13
| | | | | | | | | Extend commit eb35d8884b (find_package: Use PackageName_ROOT variables as search prefixes, 2018-03-15, v3.12.0-rc1~349^2) to also check upper-case `<PACKAGENAME>_ROOT` variables. Add policy `CMP0144` to enable the behavior in a compatible way. Fixes: #24403
* Help: Document <PackageName>_ROOT variable ordering using an ordered listBrad King2023-02-231-15/+22
| | | | Make room to add more steps in a documented order.
* Help: Make VALIDATOR wording clearer and more preciseCraig Scott2022-11-071-9/+14
|
* Merge topic 'CMAKE_FIND_USE_INSTALL_PREFIX-support-staging-prefix'Brad King2022-08-311-1/+2
|\ | | | | | | | | | | | | | | | | 0fc10bb19b CMAKE_FIND_USE_INSTALL_PREFIX considers CMAKE_STAGING_PREFIX 43d31c5198 cmFindBase: Refactor CMAKE_FIND_USE_INSTALL_PREFIX handling Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7623
| * CMAKE_FIND_USE_INSTALL_PREFIX considers CMAKE_STAGING_PREFIXRobert Maynard2022-08-301-1/+2
| | | | | | | | Fixes #23900
* | Merge topic 'doc-find_package-typo'Brad King2022-08-041-2/+2
|\ \ | |/ | | | | | | | | | | 5635d33656 Help: Fix reST syntax typo in find_package docs Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7540
| * Help: Fix reST syntax typo in find_package docsEisuke Kawashima2022-08-031-2/+2
| |
* | find_(program,library,file,path): add validation functionMarc Chevrier2022-06-141-0/+21
|/ | | | Fixes: #23603
* Help: Avoid duplicating registry query syntax in multiple find_* commandsMarc Chevrier2022-05-181-4/+2
| | | | | | In commit 8d7e80cf3d (find_* commands: add control over Windows registry views, 2022-04-16) we added documentation that is repeated by multiple find commands. Move it to a dedicated manual section to avoid duplication.
* find_* commands: add control over Windows registry viewsMarc Chevrier2022-04-291-0/+13
| | | | Fixes: #22775
* Find: Support per call disabling of CMAKE_INSTALL_PREFIXRobert Maynard2022-04-151-3/+6
| | | | Fixes #23359
* Help: Clarify behavior of search ignore-related variablesCraig Scott2022-03-131-0/+5
| | | | | | | | | | | Not all the behaviors of CMake variables for ignoring search locations by find_...() commands were fully documented. Add the missing effects, clarify the wording and restructure the way the details are assembled to reduce duplication. Also improve the cross-referencing to ensure all the related variables are more discoverable. Issue: #20878
* find_*: Add support for option NO_CACHEMarc Chevrier2021-06-021-2/+19
| | | | | | | | Request that find result is stored in a normal variable rather than a cache entry. Fixes: #20687 Issue: #20743
* Find: Document that first argument to PATHS and HINTS can be ENV{}Robert Maynard2021-03-051-2/+2
|
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-18/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
* Document which environment variables effect CMAKE_SYSTEM_PREFIX_PATHRobert Maynard2020-05-191-0/+4
|
* find_*: Add support for REQUIRED keywordSylvain Joubert2020-03-061-2/+7
| | | | | | In the same spirit as the REQUIRED keyword on find_package, this will stop cmake execution with an error on a failed find_program, find_file, find_path or find_library.
* Help: Document that <PackageName>_ROOT applies to config packages tooCraig Scott2019-10-271-6/+7
| | | | | | | | | The original intent of <PackageName>_ROOT may have been for it to apply only to Find modules, but the implementation of the find_package() command treats modules and config packages the same. Both result in a <PackageName>_ROOT variable being pushed onto the stack of package roots. A config package can also call other find_...() commands, the behavior doesn't apply just to find modules.
* Find: Correct spelling and layout issues in CMAKE_FIND_USE_ docsRobert Maynard2019-07-091-1/+1
|
* Find: Provide global controls for the `NO_[]_PATH` call optionsRobert Maynard2019-06-211-5/+11
|
* Help: Spell out ";-list" as "semicolon-separated list"Joachim Wuttke (o)2018-10-251-1/+1
|
* Help: Replace occurrences of "Mac OS X" with "macOS"Bartosz Kosiorek2018-09-051-1/+1
| | | | | | | | Apple's main Operating system changed their name from OS X to macOS: https://www.engadget.com/2016/06/13/os-x-is-now-macos/ Revise documentation accordingly.
* Help: Add explicit <PackageName>_ROOT variable documentationBrad King2018-07-201-9/+15
| | | | | | Add documentation for both the CMake variable and environment variable of this name pattern. Update references to these names to link to their documents. Clarify the pattern used to construct their names.
* Fix misc. typosluz.paz2018-06-041-1/+1
| | | | Found via `codespell` and `grep`
* Help: Some spelling corrections for commands.Yee Fan2018-04-211-1/+1
|
* find_package: Use PackageName_ROOT variables as search prefixesBrad King2018-03-161-6/+23
| | | | | | | | | | | | | | | | | | | This feature was originally added by commit v3.9.0-rc1~71^2~2 (find_*: Add a new PackageRoot search path group, 2017-05-03) and documented by commit v3.9.0-rc1~71^2 (find_*: Add docs for PackageRoot search path group, 2017-05-03). However, we had to disable the feature and remove the documentation in commit v3.9.1~2^2 (find_*: Disable the PACKAGE_ROOT search path group for CMake 3.9, 2017-08-08) due to breaking projects that used `PackageName_ROOT` variables themselves. Add policy `CMP0074` to restore the `PackageName_ROOT` variable behavior in a compatible way. Also revise the stack of root paths to store the paths themselves rather than the package names. This way the policy can be considered at the `find_package` call site instead of individual `find_` calls inside a find module. Co-Author: Chuck Atkins <chuck.atkins@kitware.com> Issue: #17144
* find_*: Disable the PACKAGE_ROOT search path group for CMake 3.9Brad King2017-08-081-22/+6
| | | | | | | | | | | | | | | | Disable the feature added by commit v3.9.0-rc1~71^2~2 (find_*: Add a new PackageRoot search path group, 2017-05-03) and remove documentation added by commit v3.9.0-rc1~71^2 (find_*: Add docs for PackageRoot search path group, 2017-05-03). Unfortunately the name `<pkg>_ROOT` may already be set by projects for their own incompatible purposes. Disable the behavior change for now to fix the regression for CMake 3.9. We can restore it later with a policy. In order to keep the implementation and tests working, add an undocumented variable we can use in the tests to enable the behavior before the policy is introduced. Fixes: #17144
* find_*: Add docs for PackageRoot search path groupChuck Atkins2017-05-191-7/+23
|
* Help: Document find command search path separatorsBrad King2017-04-181-1/+4
| | | | | | | | The `find_*` commands read search paths from both CMake variables and from environment variables. Document how multiple values in these variables should be separated. Fixes: #16800
* Help: Document find_* command versioned/unversioned name orderingBrad King2015-06-081-0/+5
| | | | | Suggest in the NAMES option that unversioned names go first to prefer local builds over distro-provided files.
* Help: Improve documentation formatting of find_* commandsBrad King2015-06-081-26/+32
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORKBrad King2015-06-081-1/+4
| | | | | Add dedicated documents for these and link to them instead of duplicating their documentation in every find command.
* Teach find_(library|file|path) to get prefixes from PATH (#15370)Brad King2015-02-191-0/+4
| | | | | | | | | The find_package command already knows how to compute installation prefixes from PATH. Use the same approach to establish prefixes for find_library, find_file, and find_path to use to look in directories like "<prefix>/lib[/<arch>]" and "<prefix>/include" for libraries and headers. This will reduce the amount of configuration end users need to do to establish a work environment rooted under a specific prefix.
* Help: Factor out find_* command duplicationBrad King2013-10-161-0/+101
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.
View Lorry Controller Status