CMAKE PRINT VARIABLE MANUAL
CMAKE PRINT VARIABLE CODE

Optionally, the runtime library search path for use when running an executable linked to shared libraries. The contained message will be printed by the find_package() command and by find_package_handle_standard_args() to inform the user about the problem. Should be set by config-files in the case that it has set Xxx_FOUND to FALSE. Set to false, or undefined, if we haven’t found, or don’t want to use Xxx.

If False, optional Yy part of Xxx system is not available. If False, do not try to use the relevant CMake wrapping command. Make sure at most one of these is ever true. Optionally, the final set of library directories listed in one variable for use by client code. Where to find the Yyy tool that comes with Xxx. This really shouldn’t include options such as -DHAS_JPEG that a client source-code file uses to decide whether to #include Xxx_EXECUTABLE

CMAKE PRINT VARIABLE CODE

Xxx_DEFINITIONSĭefinitions to use when compiling code that uses Xxx. The libraries to link against to use Xxx. The final set of include directories listed in one variable for use by client code. Note that all variables start with Xxx_ to make sure they do not interfere with other find modules the same consideration applies to macros, functions and imported targets. Standard Variable Namesįor a FindXxx.cmake module that takes the approach of setting variables (either instead of or in addition to creating imported targets), the following variable names should be used to keep things consistent between find modules.

If Foo_FIND_COMPONENTS is not set, which modules are searched for and required is up to the find module, but should be documented.įor internal implementation, it is a generally accepted convention that variables starting with underscore are for temporary use only. The HANDLE_COMPONENTS argument of find_package_handle_standard_args() can be used to implement this. Packages that find multiple semi-independent parts (like bundles of libraries) should search for the components listed in Foo_FIND_COMPONENTS if it is set, and only set Foo_FOUND to true if for each searched-for component that was not found, Foo_FIND_REQUIRED_ is not set to true. If neither are set to true, it should print a non-fatal message if it cannot find the package. If Foo_FIND_REQUIRED is set to true, the module should issue a FATAL_ERROR if the package cannot be found. If Foo_FIND_QUIETLY is set to true, it should avoid printing messages, including anything complaining about the package not being found. Most of these are dealt with by using FindPackageHandleStandardArgs.īriefly, the module should only locate versions of the package compatible with the requested version, as described by the Foo_FIND_VERSION family of variables. See the find_package() documentation for details on what variables are set for the find module. In either case (or even when providing both variables and imported targets), find modules should provide backwards compatibility with old versions that had the same name.Ī FindFoo.cmake module will typically be loaded by the command: find_package(Foo ]]] This has the advantage of propagating Transitive Usage Requirements to consumers. The more modern approach is to behave as much like config file packages files as possible, by providing imported target. This is what most of the existing find modules provided by CMake do. The traditional approach is to use variables for everything, including libraries and executables: see the Standard Variable Names section below. A find module is useful in cases where an upstream library does not provide a config file package. The primary task of a find module is to determine whether a package exists on the system, set the _FOUND variable to reflect this and provide any variables, macros and imported targets required to use the package. Find ModulesĪ “find module” is a Find.cmake file to be loaded by the find_package() command when invoked for. It includes links to contribution instructions, which in turn link to developer guides for CMake itself.

See to get involved in development of CMake upstream.

CMAKE PRINT VARIABLE MANUAL

This manual is intended for reference by developers working with cmake-language(7) code, whether writing their own modules, authoring their own build systems, or working on CMake itself.

Cmake print variable