mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-07 06:09:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'patch-FindPatch'

Browse Source 
a01b092e19 FindPatch: Update documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10610
This commit is contained in:
Brad King
2025-04-08 14:30:05 +00:00
committed by Kitware Robot
parent 9652aa9dc3 a01b092e19
commit e6103a2c66
2 changed files with 53 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
Modules/FindPatch.cmake
View File

@@ -7,29 +7,67 @@ FindPatch
.. versionadded:: 3.10
The module defines the following variables:
Finds the ``patch`` command-line executable for applying diff patches to
original files.
``Patch_EXECUTABLE``
Path to patch command-line executable.
``Patch_FOUND``
True if the patch command-line executable was found.
Imported Targets
^^^^^^^^^^^^^^^^
The following :prop_tgt:`IMPORTED` targets are also defined:
This module provides the following :ref:`Imported Targets`:
``Patch::patch``
The command-line executable.
Target encapsulating the ``patch`` command-line executable, available only if
``patch`` is found.
.. versionchanged:: 4.0
Imported target is defined only when :prop_gbl:`CMAKE_ROLE` is ``PROJECT``.
This imported target is defined only when :prop_gbl:`CMAKE_ROLE` is
``PROJECT``.
Example usage:
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``Patch_FOUND``
Boolean indicating whether the ``patch`` command-line executable is found.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``Patch_EXECUTABLE``
The path to the ``patch`` command-line executable.
Examples
^^^^^^^^
Finding ``patch`` command and executing it in a process:
.. code-block:: cmake
find_package(Patch)
if(Patch_FOUND)
message("Patch found: ${Patch_EXECUTABLE}")
endif()
find_package(Patch)
if(Patch_FOUND)
execute_process(
COMMAND ${Patch_EXECUTABLE} -p1 -i ${CMAKE_CURRENT_SOURCE_DIR}/src.patch
)
endif()
The imported target can be used, for example, inside the
:command:`add_custom_command` command, which patches the given file when some
build rule depends on its output:
.. code-block:: cmake
find_package(Patch)
if(TARGET Patch::patch)
# Executed when some build rule depends on the src.c file.
add_custom_command(
OUTPUT src.c
COMMAND Patch::patch -p1 -i ${CMAKE_CURRENT_SOURCE_DIR}/src.patch
# ...
)
endif()
#]=======================================================================]
set(_doc "Patch command line executable")

4
Tests/FindPatch/Test/CMakeLists.txt
View File

@@ -6,8 +6,8 @@ macro(_check)
message(FATAL_ERROR "Failed to lookup Patch_EXECUTABLE [${Patch_EXECUTABLE}]")
endif()
if(NOT DEFINED PATCH_FOUND)
message(FATAL_ERROR "Variable PATCH_FOUND is not defined")
if(NOT DEFINED Patch_FOUND)
message(FATAL_ERROR "Variable Patch_FOUND is not defined")
endif()
# Is import target available ?