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

FindPackageHandleStandardArgs: Clarify the FOUND_VAR option

Browse Source 
The `find_package_handle_standard_args(FOUND_VAR)` is deprecated as of
CMake 3.3 and both the `<PackageName>_FOUND` and the upper-cased
`<PACKAGE_NAME>_FOUND` are set with or without using this option.
Additionally, find modules and docs are also synced with this to make it
clearer.
This commit is contained in:
Peter Kokot 2024-12-31 02:07:16 +01:00
parent 4771754c0d
commit 1a8e43d57d
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
24 changed files with 9 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Help/manual/cmake-developer.7.rst
View File

@ -470,7 +470,6 @@ rest of the work for us
include(FindPackageHandleStandardArgs) include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Foo find_package_handle_standard_args(Foo
FOUND_VAR Foo_FOUND
REQUIRED_VARS REQUIRED_VARS
Foo_LIBRARY Foo_LIBRARY
Foo_INCLUDE_DIR Foo_INCLUDE_DIR

2
Modules/FindBacktrace.cmake
View File

@ -98,7 +98,7 @@ endif()
set(Backtrace_LIBRARIES ${Backtrace_LIBRARY}) set(Backtrace_LIBRARIES ${Backtrace_LIBRARY})
set(Backtrace_HEADER "${_Backtrace_HEADER_TRY}" CACHE STRING "Header providing backtrace(3) facility") set(Backtrace_HEADER "${_Backtrace_HEADER_TRY}" CACHE STRING "Header providing backtrace(3) facility")
find_package_handle_standard_args(Backtrace FOUND_VAR Backtrace_FOUND REQUIRED_VARS ${_Backtrace_STD_ARGS}) find_package_handle_standard_args(Backtrace REQUIRED_VARS ${_Backtrace_STD_ARGS})
mark_as_advanced(Backtrace_HEADER Backtrace_INCLUDE_DIR Backtrace_LIBRARY) mark_as_advanced(Backtrace_HEADER Backtrace_INCLUDE_DIR Backtrace_LIBRARY)
if(Backtrace_FOUND AND NOT TARGET Backtrace::Backtrace) if(Backtrace_FOUND AND NOT TARGET Backtrace::Backtrace)

2
Modules/FindFontconfig.cmake
View File

@ -80,8 +80,6 @@ endif ()
include(FindPackageHandleStandardArgs) include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Fontconfig find_package_handle_standard_args(Fontconfig
FOUND_VAR
Fontconfig_FOUND
REQUIRED_VARS REQUIRED_VARS
Fontconfig_LIBRARY Fontconfig_LIBRARY
Fontconfig_INCLUDE_DIR Fontconfig_INCLUDE_DIR

2
Modules/FindGSL.cmake
View File

@ -153,8 +153,6 @@ endif()
# handle the QUIETLY and REQUIRED arguments and set GSL_FOUND to TRUE if all # handle the QUIETLY and REQUIRED arguments and set GSL_FOUND to TRUE if all
# listed variables are TRUE # listed variables are TRUE
find_package_handle_standard_args( GSL find_package_handle_standard_args( GSL
FOUND_VAR
GSL_FOUND
REQUIRED_VARS REQUIRED_VARS
GSL_INCLUDE_DIR GSL_INCLUDE_DIR
GSL_LIBRARY GSL_LIBRARY

1
Modules/FindIce.cmake
View File

@ -542,7 +542,6 @@ _Ice_FIND()
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Ice FIND_PACKAGE_HANDLE_STANDARD_ARGS(Ice
FOUND_VAR Ice_FOUND
REQUIRED_VARS Ice_SLICE2CPP_EXECUTABLE REQUIRED_VARS Ice_SLICE2CPP_EXECUTABLE
Ice_INCLUDE_DIR Ice_INCLUDE_DIR
Ice_SLICE_DIR Ice_SLICE_DIR

2
Modules/FindImageMagick.cmake
View File

@ -327,8 +327,6 @@ FIND_PACKAGE_HANDLE_STANDARD_ARGS(ImageMagick
REQUIRED_VARS ${ImageMagick_REQUIRED_VARS} REQUIRED_VARS ${ImageMagick_REQUIRED_VARS}
VERSION_VAR ImageMagick_VERSION_STRING VERSION_VAR ImageMagick_VERSION_STRING
) )
# Maintain consistency with all other variables.
set(ImageMagick_FOUND ${IMAGEMAGICK_FOUND})
#--------------------------------------------------------------------- #---------------------------------------------------------------------
# DEPRECATED: Setting variables for backward compatibility. # DEPRECATED: Setting variables for backward compatibility.

1
Modules/FindIntl.cmake
View File

@ -162,7 +162,6 @@ endif()
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Intl FIND_PACKAGE_HANDLE_STANDARD_ARGS(Intl
FOUND_VAR Intl_FOUND
REQUIRED_VARS ${_Intl_REQUIRED_VARS} REQUIRED_VARS ${_Intl_REQUIRED_VARS}
VERSION_VAR Intl_VERSION VERSION_VAR Intl_VERSION
FAIL_MESSAGE "Failed to find Gettext libintl") FAIL_MESSAGE "Failed to find Gettext libintl")

2
Modules/FindLTTngUST.cmake
View File

@ -98,7 +98,7 @@ if(LTTNGUST_INCLUDE_DIRS AND LTTNGUST_LIBRARIES)
endif() endif()
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
find_package_handle_standard_args(LTTngUST FOUND_VAR LTTNGUST_FOUND find_package_handle_standard_args(LTTngUST
REQUIRED_VARS LTTNGUST_LIBRARIES REQUIRED_VARS LTTNGUST_LIBRARIES
LTTNGUST_INCLUDE_DIRS LTTNGUST_INCLUDE_DIRS
VERSION_VAR LTTNGUST_VERSION_STRING) VERSION_VAR LTTNGUST_VERSION_STRING)

2
Modules/FindLibinput.cmake
View File

@ -60,8 +60,6 @@ find_library(Libinput_LIBRARY
include(FindPackageHandleStandardArgs) include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Libinput find_package_handle_standard_args(Libinput
FOUND_VAR
Libinput_FOUND
REQUIRED_VARS REQUIRED_VARS
Libinput_LIBRARY Libinput_LIBRARY
Libinput_INCLUDE_DIR Libinput_INCLUDE_DIR

1
Modules/FindMatlab.cmake
View File

@ -2079,7 +2079,6 @@ set(Matlab_VERSION ${Matlab_VERSION_STRING})
find_package_handle_standard_args( find_package_handle_standard_args(
Matlab Matlab
FOUND_VAR Matlab_FOUND
REQUIRED_VARS ${_matlab_required_variables} REQUIRED_VARS ${_matlab_required_variables}
VERSION_VAR Matlab_VERSION VERSION_VAR Matlab_VERSION
HANDLE_VERSION_RANGE HANDLE_VERSION_RANGE

1
Modules/FindOpenCL.cmake
View File

@ -176,7 +176,6 @@ set(OpenCL_INCLUDE_DIRS ${OpenCL_INCLUDE_DIR})
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
find_package_handle_standard_args( find_package_handle_standard_args(
OpenCL OpenCL
FOUND_VAR OpenCL_FOUND
REQUIRED_VARS OpenCL_LIBRARY OpenCL_INCLUDE_DIR REQUIRED_VARS OpenCL_LIBRARY OpenCL_INCLUDE_DIR
VERSION_VAR OpenCL_VERSION_STRING) VERSION_VAR OpenCL_VERSION_STRING)

2
Modules/FindOpenMP.cmake
View File

@ -709,8 +709,6 @@ find_package_handle_standard_args(OpenMP
VERSION_VAR ${_OpenMP_MIN_VERSION} VERSION_VAR ${_OpenMP_MIN_VERSION}
HANDLE_COMPONENTS) HANDLE_COMPONENTS)
set(OPENMP_FOUND ${OpenMP_FOUND})
if(CMAKE_Fortran_COMPILER_LOADED AND OpenMP_Fortran_FOUND) if(CMAKE_Fortran_COMPILER_LOADED AND OpenMP_Fortran_FOUND)
if(NOT DEFINED OpenMP_Fortran_HAVE_OMPLIB_MODULE) if(NOT DEFINED OpenMP_Fortran_HAVE_OMPLIB_MODULE)
set(OpenMP_Fortran_HAVE_OMPLIB_MODULE FALSE CACHE BOOL INTERNAL "") set(OpenMP_Fortran_HAVE_OMPLIB_MODULE FALSE CACHE BOOL INTERNAL "")

1
Modules/FindOpenSP.cmake
View File

@ -122,7 +122,6 @@ endif ()
include(FindPackageHandleStandardArgs) include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(OpenSP find_package_handle_standard_args(OpenSP
FOUND_VAR OpenSP_FOUND
REQUIRED_VARS OpenSP_LIBRARY OpenSP_INCLUDE_DIR REQUIRED_VARS OpenSP_LIBRARY OpenSP_INCLUDE_DIR
VERSION_VAR OpenSP_VERSION VERSION_VAR OpenSP_VERSION
) )

12
Modules/FindPackageHandleStandardArgs.cmake
View File

@ -56,7 +56,8 @@ implementing :command:`find_package(<PackageName>)` calls.
Specifies either ``<PackageName>_FOUND`` or Specifies either ``<PackageName>_FOUND`` or
``<PACKAGENAME>_FOUND`` as the result variable. This exists only ``<PACKAGENAME>_FOUND`` as the result variable. This exists only
for compatibility with older versions of CMake and is now ignored. for compatibility with older versions of CMake and is now ignored.
Result variables of both names are always set for compatibility. Result variables of both names are now always set for compatibility
also with or without this option.
``REQUIRED_VARS <required-var>...`` ``REQUIRED_VARS <required-var>...``
Specify the variables which are required for this package. Specify the variables which are required for this package.
@ -467,13 +468,12 @@ function(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG)
if(FPHSA_FOUND_VAR) if(FPHSA_FOUND_VAR)
set(_FOUND_VAR_UPPER ${_NAME_UPPER}_FOUND) set(_FOUND_VAR_UPPER ${_NAME_UPPER}_FOUND)
set(_FOUND_VAR_MIXED ${_NAME}_FOUND) set(_FOUND_VAR_MIXED ${_NAME}_FOUND)
if(FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_MIXED OR FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_UPPER) if(
set(_FOUND_VAR ${FPHSA_FOUND_VAR}) NOT FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_MIXED
else() AND NOT FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_UPPER
)
message(FATAL_ERROR "The argument for FOUND_VAR is \"${FPHSA_FOUND_VAR}\", but only \"${_FOUND_VAR_MIXED}\" and \"${_FOUND_VAR_UPPER}\" are valid names.") message(FATAL_ERROR "The argument for FOUND_VAR is \"${FPHSA_FOUND_VAR}\", but only \"${_FOUND_VAR_MIXED}\" and \"${_FOUND_VAR_UPPER}\" are valid names.")
endif() endif()
else()
set(_FOUND_VAR ${_NAME_UPPER}_FOUND)
endif() endif()
# collect all variables which were not found, so they can be printed, so the # collect all variables which were not found, so they can be printed, so the

1
Modules/FindPostgreSQL.cmake
View File

@ -274,7 +274,6 @@ find_package_handle_standard_args(PostgreSQL
REQUIRED_VARS PostgreSQL_LIBRARY PostgreSQL_INCLUDE_DIR REQUIRED_VARS PostgreSQL_LIBRARY PostgreSQL_INCLUDE_DIR
HANDLE_COMPONENTS HANDLE_COMPONENTS
VERSION_VAR PostgreSQL_VERSION_STRING) VERSION_VAR PostgreSQL_VERSION_STRING)
set(PostgreSQL_FOUND ${POSTGRESQL_FOUND})
function(__postgresql_import_library _target _var _config) function(__postgresql_import_library _target _var _config)
if(_config) if(_config)

3
Modules/FindQt4.cmake
View File

@ -1325,7 +1325,7 @@ else()
# explicitly. # explicitly.
set(FPHSA_NAME_MISMATCHED 1) set(FPHSA_NAME_MISMATCHED 1)
endif () endif ()
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Qt4 FOUND_VAR Qt4_FOUND FIND_PACKAGE_HANDLE_STANDARD_ARGS(Qt4
REQUIRED_VARS ${_QT4_FOUND_REQUIRED_VARS} REQUIRED_VARS ${_QT4_FOUND_REQUIRED_VARS}
VERSION_VAR QTVERSION VERSION_VAR QTVERSION
) )
@ -1341,5 +1341,4 @@ endif()
set (QT_MOC_EXE ${QT_MOC_EXECUTABLE} ) set (QT_MOC_EXE ${QT_MOC_EXECUTABLE} )
set (QT_UIC_EXE ${QT_UIC_EXECUTABLE} ) set (QT_UIC_EXE ${QT_UIC_EXECUTABLE} )
set( QT_QT_LIBRARY "") set( QT_QT_LIBRARY "")
set(QT4_FOUND ${Qt4_FOUND})
set(QT_FOUND ${Qt4_FOUND}) set(QT_FOUND ${Qt4_FOUND})

1
Modules/FindSubversion.cmake
View File

@ -165,5 +165,4 @@ FIND_PACKAGE_HANDLE_STANDARD_ARGS(Subversion REQUIRED_VARS Subversion_SVN_EXECUT
VERSION_VAR Subversion_VERSION_SVN ) VERSION_VAR Subversion_VERSION_SVN )
# for compatibility # for compatibility
set(Subversion_FOUND ${SUBVERSION_FOUND})
set(Subversion_SVN_FOUND ${SUBVERSION_FOUND}) set(Subversion_SVN_FOUND ${SUBVERSION_FOUND})

1
Modules/FindXCTest.cmake
View File

@ -103,7 +103,6 @@ endif()
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
find_package_handle_standard_args(XCTest find_package_handle_standard_args(XCTest
FOUND_VAR XCTest_FOUND
REQUIRED_VARS XCTest_LIBRARY XCTest_INCLUDE_DIR XCTest_EXECUTABLE) REQUIRED_VARS XCTest_LIBRARY XCTest_INCLUDE_DIR XCTest_EXECUTABLE)
if(XCTest_FOUND) if(XCTest_FOUND)

1
Modules/FindXalanC.cmake
View File

@ -115,7 +115,6 @@ unset(XalanC_XERCESC_REQUIRED)
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(XalanC FIND_PACKAGE_HANDLE_STANDARD_ARGS(XalanC
FOUND_VAR XalanC_FOUND
REQUIRED_VARS XalanC_LIBRARY REQUIRED_VARS XalanC_LIBRARY
XalanC_INCLUDE_DIR XalanC_INCLUDE_DIR
XalanC_VERSION XalanC_VERSION

1
Modules/FindXercesC.cmake
View File

@ -113,7 +113,6 @@ unset(XercesC_VERSION_PATCH)
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(XercesC FIND_PACKAGE_HANDLE_STANDARD_ARGS(XercesC
FOUND_VAR XercesC_FOUND
REQUIRED_VARS XercesC_LIBRARY REQUIRED_VARS XercesC_LIBRARY
XercesC_INCLUDE_DIR XercesC_INCLUDE_DIR
XercesC_VERSION XercesC_VERSION

2
Source/Modules/FindJsonCpp.cmake
View File

@ -85,11 +85,9 @@ unset(_JsonCpp_H)
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(JsonCpp FIND_PACKAGE_HANDLE_STANDARD_ARGS(JsonCpp
FOUND_VAR JsonCpp_FOUND
REQUIRED_VARS JsonCpp_LIBRARY JsonCpp_INCLUDE_DIR REQUIRED_VARS JsonCpp_LIBRARY JsonCpp_INCLUDE_DIR
VERSION_VAR JsonCpp_VERSION_STRING VERSION_VAR JsonCpp_VERSION_STRING
) )
set(JSONCPP_FOUND ${JsonCpp_FOUND})
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
# Provide documented result variables and targets. # Provide documented result variables and targets.

2
Source/Modules/FindLibRHash.cmake
View File

@ -53,10 +53,8 @@ mark_as_advanced(LibRHash_INCLUDE_DIR)
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibRHash FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibRHash
FOUND_VAR LibRHash_FOUND
REQUIRED_VARS LibRHash_LIBRARY LibRHash_INCLUDE_DIR REQUIRED_VARS LibRHash_LIBRARY LibRHash_INCLUDE_DIR
) )
set(LIBRHASH_FOUND ${LibRHash_FOUND})
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
# Provide documented result variables and targets. # Provide documented result variables and targets.

2
Source/Modules/FindLibUUID.cmake
View File

@ -72,10 +72,8 @@ mark_as_advanced(LibUUID_INCLUDE_DIR)
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibUUID FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibUUID
FOUND_VAR LibUUID_FOUND
REQUIRED_VARS LibUUID_LIBRARY LibUUID_INCLUDE_DIR REQUIRED_VARS LibUUID_LIBRARY LibUUID_INCLUDE_DIR
) )
set(LIBUUID_FOUND ${LibUUID_FOUND})
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
# Provide documented result variables and targets. # Provide documented result variables and targets.

2
Source/Modules/FindLibUV.cmake
View File

@ -102,11 +102,9 @@ unset(_LibUV_H)
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake) include(${CMAKE_CURRENT_LIST_DIR}/../../Modules/FindPackageHandleStandardArgs.cmake)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibUV FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibUV
FOUND_VAR LibUV_FOUND
REQUIRED_VARS LibUV_LIBRARY LibUV_INCLUDE_DIR REQUIRED_VARS LibUV_LIBRARY LibUV_INCLUDE_DIR
VERSION_VAR LibUV_VERSION VERSION_VAR LibUV_VERSION
) )
set(LIBUV_FOUND ${LibUV_FOUND})
#----------------------------------------------------------------------------- #-----------------------------------------------------------------------------
# Provide documented result variables and targets. # Provide documented result variables and targets.