aboutsummaryrefslogtreecommitdiff
path: root/docs/users
diff options
context:
space:
mode:
authorPhil Christensen <philc@microsoft.com>2018-12-04 14:05:12 -0800
committerPhil Christensen <philc@microsoft.com>2018-12-04 14:05:12 -0800
commite712374b2831c4d04fc3b37373ed5cf041a3713e (patch)
tree3c1be3898e52d0e01cfc842be7ea553e8fe0bafb /docs/users
parent7f80cbdeb02a126a610f3a3262eaefa9c9f9b938 (diff)
parentf6d32cc644a6f0fb9adb1bb3c3fd4905e8d61e2e (diff)
downloadvcpkg-e712374b2831c4d04fc3b37373ed5cf041a3713e.tar.gz
vcpkg-e712374b2831c4d04fc3b37373ed5cf041a3713e.zip
Merge branch 'master' of https://github.com/microsoft/vcpkg into dev/philc/4889
Diffstat (limited to 'docs/users')
-rw-r--r--docs/users/integration.md2
-rw-r--r--docs/users/triplets.md11
2 files changed, 12 insertions, 1 deletions
diff --git a/docs/users/integration.md b/docs/users/integration.md
index ce52abe23..fbaea41d9 100644
--- a/docs/users/integration.md
+++ b/docs/users/integration.md
@@ -35,7 +35,7 @@ cmake ../my/project -DCMAKE_TOOLCHAIN_FILE=C:\vcpkg\scripts\buildsystems\vcpkg.c
```
Projects configured with the Vcpkg toolchain file will have the appropriate Vcpkg folders added to the cmake search paths. This makes all libraries available to be found through `find_package()`, `find_path()`, and `find_library()`.
-See [Example: Using Sqlite](../examples/using-sqlite.md) for a fully worked example using our CMake toolchain.
+See [Installing and Using Packages Example: sqlite](../examples/installing-and-using-packages.md) for a fully worked example using our CMake toolchain.
Note that we do not automatically add ourselves to your compiler include paths. To use a header-only library, simply use `find_path()`, which will correctly work on all platforms:
```cmake
diff --git a/docs/users/triplets.md b/docs/users/triplets.md
index 2bb9c74b3..9ff372aed 100644
--- a/docs/users/triplets.md
+++ b/docs/users/triplets.md
@@ -69,6 +69,17 @@ This option also has forms for configuration-specific and C flags:
- `VCPKG_C_FLAGS_DEBUG`
- `VCPKG_C_FLAGS_RELEASE`
+## macOS Variables
+
+### VCPKG_INSTALL_NAME_DIR
+Sets the install name used when building macOS dynamic libraries. Default value is `@rpath`. See the CMake documentation for [CMAKE_INSTALL_NAME_DIR](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_NAME_DIR.html) for more information.
+
+### VCPKG_OSX_DEPLOYMENT_TARGET
+Sets the minimum macOS version for compiled binaries. This also changes what versions of the macOS platform SDK that CMake will search for. See the CMake documentation for [CMAKE_OSX_DEPLOYMENT_TARGET](https://cmake.org/cmake/help/latest/variable/CMAKE_OSX_DEPLOYMENT_TARGET.html) for more information.
+
+### VCPKG_OSX_SYSROOT
+Set the name or path of the macOS platform SDK that will be used by CMake. See the CMake documentation for [CMAKE_OSX_SYSROOT](https://cmake.org/cmake/help/latest/variable/CMAKE_OSX_SYSROOT.html) for more information.
+
## Per-port customization
The CMake Macro `PORT` will be set when interpreting the triplet file and can be used to change settings (such as `VCPKG_LIBRARY_LINKAGE`) on a per-port basis.