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.

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

Fix vcpkg package name in doc #1392

Merged
merged 2 commits into from
May 18, 2022
Merged
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion docs/building-with-vcpkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ source release of OpenTelemetry C++ SDK.
The following command can be used to install the public open source release:

```console
vcpkg install opentelemetry
vcpkg install opentelemetry-cpp
Copy link
Member

@lalitb lalitb May 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be
vcpkg install opentelemetry.
This documentation talks about the installing the opentelemetry port which comes as part of this repo - https://github.com/open-telemetry/opentelemetry-cpp/tree/main/tools/ports/opentelemetry

The installation for opentelemetry port available in vcpkg registry is described here - https://github.com/open-telemetry/opentelemetry-cpp/blob/main/INSTALL.md#using-package-managers

Ideally, we should cleanup the internal port now that it is available in vcpkg registry.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lalitb it makes sense. To install our port in this repo, do we need provide some extra option to vcpkg for our overlay, I think just vcpkg install opentelemetry would not work. Thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, right it won't work without the overlay option. I think we can keep changes from this PR.

```

That's it! The package should be compiled for the current OS.
Expand Down