mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-20 13:22:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Correct macro -> function in FindPackageMessage.

Browse Source 
Correct in the text, and change capitalization accordingly.
This commit is contained in:
Joachim Wuttke (l)
2018-11-12 14:35:44 +01:00
committed by Joachim Wuttke (o)
parent c310480c5d
commit 89b5f4fcc7
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Modules/FindPackageMessage.cmake
View File

@@ -5,14 +5,14 @@
FindPackageMessage FindPackageMessage
------------------ ------------------
.. code-block:: cmake
find_package_message(<name> "message for user" "find result details")
FIND_PACKAGE_MESSAGE(<name> "message for user" "find result details") This function is intended to be used in FindXXX.cmake modules files.
It will print a message once for each unique find result. This is
This macro is intended to be used in FindXXX.cmake modules files. It useful for telling the user where a package was found. The first
will print a message once for each unique find result. This is useful argument specifies the name (XXX) of the package. The second argument
for telling the user where a package was found. The first argument
specifies the name (XXX) of the package. The second argument
specifies the message to display. The third argument lists details specifies the message to display. The third argument lists details
about the find result so that if they change the message will be about the find result so that if they change the message will be
displayed again. The macro also obeys the QUIET argument to the displayed again. The macro also obeys the QUIET argument to the
@@ -20,17 +20,17 @@ find_package command.
Example: Example:
:: .. code-block:: cmake
if(X11_FOUND) if(X11_FOUND)
FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}" find_package_message(X11 "Found X11: ${X11_X11_LIB}"
"[${X11_X11_LIB}][${X11_INCLUDE_DIR}]") "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
else() else()
... ...
endif() endif()
#]=======================================================================] #]=======================================================================]
function(FIND_PACKAGE_MESSAGE pkg msg details) function(find_package_message pkg msg details)
# Avoid printing a message repeatedly for the same find result. # Avoid printing a message repeatedly for the same find result.
if(NOT ${pkg}_FIND_QUIETLY) if(NOT ${pkg}_FIND_QUIETLY)
string(REPLACE "\n" "" details "${details}") string(REPLACE "\n" "" details "${details}")