echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CheckIPOSupported: Update documentation

Browse Source 
- Added some minor descriptions and include() to examples
- The second example extended also with option() as it is very common
  usage in CMake to enable IPO conditionally
This commit is contained in:
Peter Kokot 2025-03-08 22:05:05 +01:00
parent 24a1a7ac5d
commit a04fd272c2
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Modules/CheckIPOSupported.cmake
View File

@ -7,9 +7,9 @@ CheckIPOSupported
.. versionadded:: 3.9
Check whether the compiler supports an interprocedural optimization (IPO/LTO).
Use this before enabling the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target
property.
This module provides a function to check whether the compiler supports an
interprocedural optimization (IPO/LTO). Use this module before enabling the
:prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target property.
.. command:: check_ipo_supported
@ -60,21 +60,33 @@ property.
Examples
^^^^^^^^
Checking whether the compiler supports IPO and emitting a fatal error if it is
not supported:
.. code-block:: cmake
include(CheckIPOSupported)
check_ipo_supported() # fatal error if IPO is not supported
set_property(TARGET foo PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
The following example demonstrates how to use the ``CheckIPOSupported`` module
to enable IPO for the target only when supported by the compiler and to issue a
warning if it is not. Additionally, projects may want to provide a
configuration option to control when IPO is enabled. For example:
.. code-block:: cmake
# Optional IPO. Do not use IPO if it's not supported by compiler.
check_ipo_supported(RESULT result OUTPUT output)
if(result)
set_property(TARGET foo PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
else()
message(WARNING "IPO is not supported: ${output}")
endif()
option(FOO_ENABLE_IPO "Enable IPO/LTO")
if(FOO_ENABLE_IPO)
include(CheckIPOSupported)
check_ipo_supported(RESULT result OUTPUT output)
if(result)
set_property(TARGET foo PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
else()
message(WARNING "IPO is not supported: ${output}")
endif()
endif()
#]=======================================================================]
# X_RESULT - name of the final result variable