FindPackageHandleStandardArgs: Clarify the FOUND_VAR option

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.

Help/manual/cmake-developer.7.rst

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

Modules/FindBacktrace.cmake

@@ -98,7 +98,7 @@ endif()
 set(Backtrace_LIBRARIES ${Backtrace_LIBRARY})
 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)
 
 if(Backtrace_FOUND AND NOT TARGET Backtrace::Backtrace)

Modules/FindFontconfig.cmake

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

Modules/FindGSL.cmake

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

Modules/FindIce.cmake

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

Modules/FindImageMagick.cmake

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

Modules/FindIntl.cmake

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

Modules/FindLTTngUST.cmake

@@ -98,7 +98,7 @@ if(LTTNGUST_INCLUDE_DIRS AND LTTNGUST_LIBRARIES)
 endif()
 
 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
                                                 LTTNGUST_INCLUDE_DIRS
                                   VERSION_VAR LTTNGUST_VERSION_STRING)

Modules/FindLibinput.cmake

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

Modules/FindMatlab.cmake

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

Modules/FindOpenCL.cmake

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

Modules/FindOpenMP.cmake

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

Modules/FindOpenSP.cmake

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

Modules/FindPackageHandleStandardArgs.cmake

@@ -56,7 +56,8 @@ implementing :command:`find_package(<PackageName>)` calls.
     Specifies either ``<PackageName>_FOUND`` or
     ``<PACKAGENAME>_FOUND`` as the result variable.  This exists only
     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>...``
     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)
     set(_FOUND_VAR_UPPER ${_NAME_UPPER}_FOUND)
     set(_FOUND_VAR_MIXED ${_NAME}_FOUND)
-    if(FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_MIXED  OR  FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_UPPER)
-      set(_FOUND_VAR ${FPHSA_FOUND_VAR})
-    else()
+    if(
+      NOT FPHSA_FOUND_VAR STREQUAL _FOUND_VAR_MIXED
+      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.")
     endif()
-  else()
-    set(_FOUND_VAR ${_NAME_UPPER}_FOUND)
   endif()
 
   # collect all variables which were not found, so they can be printed, so the

Modules/FindPostgreSQL.cmake

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

Modules/FindQt4.cmake

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

Modules/FindSubversion.cmake

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

Modules/FindXCTest.cmake

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

Modules/FindXalanC.cmake

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

Modules/FindXercesC.cmake

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

Source/Modules/FindJsonCpp.cmake

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

Source/Modules/FindLibRHash.cmake

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

Source/Modules/FindLibUUID.cmake

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

Source/Modules/FindLibUV.cmake

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