aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Romero <romerosanchezv@gmail.com>2019-01-24 16:45:23 -0800
committerGitHub <noreply@github.com>2019-01-24 16:45:23 -0800
commit3a4b6caacb4454097a2ecf001bd3126822f4fbf8 (patch)
tree60c4c8162ae850886f6d807833cac6f15b9ad20a
parent7d5fa69b3336dfca70539c77f536dc81633703f1 (diff)
parent370984d139c0799446e45706b45c8cb8eb77db44 (diff)
downloadvcpkg-3a4b6caacb4454097a2ecf001bd3126822f4fbf8.tar.gz
vcpkg-3a4b6caacb4454097a2ecf001bd3126822f4fbf8.zip
Merge pull request #4767 from Farwaykorse/documentation
[documentation] Add note to "delete CMake cache after editing CMakeSettings.json"
-rw-r--r--docs/examples/installing-and-using-packages.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/examples/installing-and-using-packages.md b/docs/examples/installing-and-using-packages.md
index 50200c877..73f9d29a9 100644
--- a/docs/examples/installing-and-using-packages.md
+++ b/docs/examples/installing-and-using-packages.md
@@ -89,7 +89,8 @@ To remove the integration for your user, you can use `.\vcpkg integrate remove`.
<a name="cmake"></a>
#### CMake (Toolchain File)
-The best way to use installed libraries with cmake is via the toolchain file `scripts\buildsystems\vcpkg.cmake`. To use this file, you simply need to add it onto your CMake command line as `-DCMAKE_TOOLCHAIN_FILE=D:\src\vcpkg\scripts\buildsystems\vcpkg.cmake`.
+The best way to use installed libraries with cmake is via the toolchain file `scripts\buildsystems\vcpkg.cmake`. To use this file, you simply need to add it onto your CMake command line as:
+`-DCMAKE_TOOLCHAIN_FILE=D:\src\vcpkg\scripts\buildsystems\vcpkg.cmake`.
If you are using CMake through Open Folder with Visual Studio 2017 you can define `CMAKE_TOOLCHAIN_FILE` by adding a "variables" section to each of your `CMakeSettings.json` configurations:
@@ -109,6 +110,7 @@ If you are using CMake through Open Folder with Visual Studio 2017 you can defin
}]
}
```
+*Note: It might be necessary to delete the CMake cache folder of each modified configuration, to force a full regeneration. In the `CMake` menu, under `Cache (<configuration name>)` you'll find `Delete Cache Folders`.*
Now let's make a simple CMake project with a main file.
```cmake