vcpkg/docs/maintainers/vcpkg_apply_patches.md

# vcpkg_apply_patches

Apply a set of patches to a source tree. This function is deprecated in favor of the `PATCHES` argument to `vcpkg_from_github()` et al.

## Usage
```cmake
vcpkg_apply_patches(
    SOURCE_PATH <${SOURCE_PATH}>
    [QUIET]
    PATCHES <patch1.patch>...
)
```

## Parameters
### SOURCE_PATH
The source path in which apply the patches. By convention, this is usually set in the portfile as the variable `SOURCE_PATH`.

### PATCHES
A list of patches that are applied to the source tree.

Generally, these take the form of `${CMAKE_CURRENT_LIST_DIR}/some.patch` to select patches in the `port\<port>\` directory.

### QUIET
Disables the warning message upon failure.

This should only be used for edge cases, such as patches that are known to fail even on a clean source tree.

## Examples

* [libbson](https://github.com/Microsoft/vcpkg/blob/master/ports/libbson/portfile.cmake)
* [gdal](https://github.com/Microsoft/vcpkg/blob/master/ports/gdal/portfile.cmake)

## Source
[scripts/cmake/vcpkg_apply_patches.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_apply_patches.cmake)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`# vcpkg_apply_patches`

[vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` (#7606) * [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` * [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install. 2020-02-13 07:58:43 +08:00			Apply a set of patches to a source tree. This function is deprecated in favor of the `PATCHES` argument to `vcpkg_from_github()` et al.
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00
			`## Usage`
			```cmake
			`vcpkg_apply_patches(`
			`SOURCE_PATH <${SOURCE_PATH}>`
			`[QUIET]`
			`PATCHES <patch1.patch>...`
			`)`
			```

			`## Parameters`
			`### SOURCE_PATH`
			The source path in which apply the patches. By convention, this is usually set in the portfile as the variable `SOURCE_PATH`.

			`### PATCHES`
			`A list of patches that are applied to the source tree.`

			Generally, these take the form of `${CMAKE_CURRENT_LIST_DIR}/some.patch` to select patches in the `port\<port>\` directory.

			`### QUIET`
			`Disables the warning message upon failure.`

			`This should only be used for edge cases, such as patches that are known to fail even on a clean source tree.`

			`## Examples`

[vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` (#7606) * [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` * [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install. 2020-02-13 07:58:43 +08:00			`* [libbson](https://github.com/Microsoft/vcpkg/blob/master/ports/libbson/portfile.cmake)`
			`* [gdal](https://github.com/Microsoft/vcpkg/blob/master/ports/gdal/portfile.cmake)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00
			`## Source`
			`[scripts/cmake/vcpkg_apply_patches.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_apply_patches.cmake)`