summaryrefslogtreecommitdiffstats
path: root/Help/command/find_package.rst
Commit message (Collapse)AuthorAgeFilesLines
* Various typo fixesLuz Paz2018-01-031-1/+1
| | | | Some are user-facing. Others are source comments.
* find_*: Disable the PACKAGE_ROOT search path group for CMake 3.9Brad King2017-08-081-15/+8
| | | | | | | | | | | | | | | | 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-9/+16
|
* 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
* find_package: Optionally sort globbed directories in a meaningful orderPierluigi Taddei2016-09-151-4/+14
| | | | | | | | | | | | Add `CMAKE_FIND_PACKAGE_SORT_{ORDER,DIRECTION}` variables to specify sort order and direction. When multiple package with the same name have been found in the same location sorting option can be used to force a specific version to be loaded (e.g. libA_1.12.0 instead of libA_1.1.0). Currently sorting by NAME and by NATURAL order have been implemented. Natural ordering makes use of the `strverscmp(3)` ordering.
* find_package: Extend search path for combined Windows/UNIX conventionSilvio Traversaro2016-08-241-0/+3
| | | | | | | | Find packages that install their cmake package configuration files in `lib/cmake/<name>` when they are installed in the default Windows CMAKE_INSTALL_PREFIX, `C:/Program Files/<name>`. Closes: #16212
* Help: Widen find_package search path tableSilvio Traversaro2016-08-231-7/+7
| | | | Make room for additional longer entries.
* Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORKBrad King2015-06-081-4/+3
| | | | | Add dedicated documents for these and link to them instead of duplicating their documentation in every find command.
* find_package: Drop search in recent cmake-gui locationsBrad King2015-05-081-11/+5
| | | | | | | | | | | | | | | | | | | | | | The find_package command, on Windows, has always searched build trees recently visited by cmake-gui (or CMakeSetup at one time). This was done when the command was created with the intention of simplifying workflows involving building multiple dependent projects. However, this behavior depends on recent developer interaction and therefore can create different find results based on transient system states. It can lead to surprising results and user confusion. Since this behavior was first added CMake has gained many more search options, better error messages when a package is not found, and a package registry. The latter in particular allows projects to make their build trees available for dependent projects to find without user intervention. Therefore the originally intended workflow can be achieved in other, more stable ways. After the above evoluion of find_package we have now decided that the magic search-where-cmake-gui-was behavior does more harm than good. Drop it. We do not need a policy for this behavior change because it only affects interactive use.
* find_package: Document CMAKE_FIND_PACKAGE_NAME variableGregor Jasny2015-01-111-0/+2
| | | | Signed-off-by: Gregor Jasny <gjasny@googlemail.com>
* Allow the Package Registry to be disabled (#14849)Daniele E. Domenichelli2014-05-121-2/+6
| | | | | | | | | | | | | | | | When a project is packaged for redistribution the local package registries should not be updated or consulted. They are for developers. Add variables to disable use of package registries globally: * CMAKE_EXPORT_NO_PACKAGE_REGISTRY that disables the export(PACKAGE) command * CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY that disables the User Package Registry in all the find_package calls. * CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY that disables the System Package Registry in all the find_package calls. Update documentation and unit tests.
* Help: Mention in find_package that cmake-gui step is Windows-only (#14781)Brad King2014-03-031-0/+1
| | | | | | | Recently used cmake-gui locations are searched only on Windows because the Windows registry is used to record the values. This behavior is historical and may be removed by a policy in the future so rather than implementing it on other platforms simply document the current behavior.
* Help: Format find_package() command documentationBrad King2014-02-171-189/+171
| | | | | Add inline markup and explicit markup block syntax as needed. Add cross-references to other documentation as appropriate.
* Help: Document the CMAKE_FIND_ROOT_PATH* variables.Stephen Kelly2013-11-271-1/+1
| | | | | Add a replacement template for the variables, and link to them from the documentation for the find_* commands.
* Help: Factor out find_* command duplicationBrad King2013-10-161-52/+8
| | | | | | | 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.
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+406
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.