From d835a0e448f264369c8a56c4131efb4a36dc12b5 Mon Sep 17 00:00:00 2001 From: Daniel Lemire Date: Tue, 30 Jul 2024 18:48:06 -0400 Subject: [PATCH] doc: warn users that PATCHES may not work properly when CPM_SOURCE_CACHE is unset. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 33fbbc89..1a89c263 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,7 @@ On the other hand, if `VERSION` hasn't been explicitly specified, CPM can automa `GIT_TAG` can also be set to a specific commit or a branch name such as `master`, however this isn't recommended, as such packages will only be updated when the cache is cleared. `PATCHES` takes a list of patch files to apply sequentially. For a basic example, see [Highway](examples/highway/CMakeLists.txt). +We recommend that if you use `PATCHES`, you also set `CPM_SOURCE_CACHE`. See [issue 577](https://github.com/cpm-cmake/CPM.cmake/issues/577). If an additional optional parameter `EXCLUDE_FROM_ALL` is set to a truthy value, then any targets defined inside the dependency won't be built by default. See the [CMake docs](https://cmake.org/cmake/help/latest/prop_tgt/EXCLUDE_FROM_ALL.html) for details.