Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document vcpkg toolchain configuration #913

Merged
merged 6 commits into from
Jul 20, 2021
Merged

Document vcpkg toolchain configuration #913

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64df9ab
vcpkg toolchain file document
lalitb Jul 20, 2021
7d38437
vcpkg toolchain file document
lalitb Jul 20, 2021
3e2a5e3
Merge branch 'main' into doc-vcpkg
lalitb Jul 20, 2021
e97d05e
format fix
lalitb Jul 20, 2021
d12b8b9
Merge branch 'doc-vcpkg' of github.com:lalitb/opentelemetry-cpp into …
lalitb Jul 20, 2021
9e3082d
Update docs/building-with-vcpkg.md
lalitb Jul 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/building-with-vcpkg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,18 @@ dependencies:
C++14 or C++17 compiler.
- `nlohmann-json` - required when building with zPages module.
- `prometheus-cpp` - required for Prometheus exporter.
- `gRPC` and `Protobuf` - required for OTLP exporter

It is possible to adjust the build system to use either vcpkg-installed
dependencies or OS-provided dependencies, e.g. `brew` or `deb` packages.
To install the dependencies through vcpkg,

- Set the VCPKG_ROOT env variable to the vcpkg install directory, or
- Set the CMake variable CMAKE_TOOLCHAIN_FILE to vcpkg toolchain file `vcpkg.cmake`.

With either of these settings, the appropriate vcpkg folders get added to the cmake
search path, and makes the required libraries to be found through `find_package()`.

The opentelemetry-cpp repo also brings the vcpkg package under `tools` directory.
This would be used during Windows builds to install the missing dependencies ONLY
if the external vcpkg toolchain is not configured.