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

Add documentation of https://github.com/microsoft/vcpkg-tool/pull/725 #27188

Merged
merged 2 commits into from
Oct 14, 2022

Conversation

BillyONeal
Copy link
Member

No description provided.

@BillyONeal BillyONeal added category:documentation To resolve the issue, documentation will need to be updated info:internal This PR or Issue was filed by the vcpkg team. labels Oct 11, 2022
github-actions[bot]
github-actions bot previously approved these changes Oct 11, 2022
ras0219-msft
ras0219-msft previously approved these changes Oct 11, 2022
@BillyONeal BillyONeal added the requires:tool-release An issue that has been fixed in the microsoft/vcpkg-tool repo and is waiting for a release thereof label Oct 11, 2022
@ras0219-msft
Copy link
Contributor

I think we should make these PRs drafts to ensure no accidents occur during PR rotation.

@BillyONeal BillyONeal marked this pull request as draft October 11, 2022 22:29
@@ -23,8 +23,8 @@ This environment variable can be set to the full path of an executable to be use

#### VCPKG_ROOT

This environment variable can be set to a directory to use as the root of the vcpkg instance. Note that mixing vcpkg
repo versions and executable versions can cause issues.
This environment variable can be set to a directory to use as the root of the vcpkg instance. This will be used if
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This environment variable can be set to a directory to use as the root of the vcpkg instance. This will be used if
This environment variable can be set to a directory to use as the root of the vcpkg instance. This will only be used if

This environment variable can be set to a directory to use as the root of the vcpkg instance. Note that mixing vcpkg
repo versions and executable versions can cause issues.
This environment variable can be set to a directory to use as the root of the vcpkg instance. This will be used if
the vcpkg executable is not located within a valid root and the command line switch `--vcpkg_root` is unused.
Copy link
Contributor

Choose a reason for hiding this comment

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

Docs for --vcpkg_root ?

Missing: Roasting of CI provides for breaking users vcpkg workflows by setting this variable ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

Docs for --vcpkg_root ?

https://github.com/microsoft/vcpkg/blob/master/docs/commands/common-options.md#--vcpkg-rootpath

Ah, looks like it should be - not _: https://github.com/microsoft/vcpkg-tool/blob/3ed4857d5cf1aa2e203aff772db3e0f4623f9ab1/include/vcpkg/vcpkgcmdarguments.h#L122

Missing: Roasting of CI provides for breaking users vcpkg workflows by setting this variable ;)

Roasting people you want to be your partners tends to not work so well :)

Copy link
Contributor

Choose a reason for hiding this comment

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

https://github.com/microsoft/vcpkg/blob/master/docs/commands/common-options.md#--vcpkg-rootpath

the link the doc? Always good to have references to stuff with more details.

@BillyONeal BillyONeal marked this pull request as ready for review October 14, 2022 00:12
@BillyONeal BillyONeal merged commit 0948fa8 into microsoft:master Oct 14, 2022
@BillyONeal BillyONeal deleted the vcpkg-root-docs branch October 14, 2022 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:documentation To resolve the issue, documentation will need to be updated info:internal This PR or Issue was filed by the vcpkg team. requires:tool-release An issue that has been fixed in the microsoft/vcpkg-tool repo and is waiting for a release thereof
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants