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

[vcpkg-cmake] Fix docs and usage of option MAYBE_UNUSED_VARIABLES #19245

Merged

Conversation

JackBoosY
Copy link
Contributor

@JackBoosY JackBoosY commented Jul 30, 2021

In the current document, our description of MAYBE_UNUSED_VARIABLES caused the user to misunderstand the parameter and incorporate the wrong changes.

Fix the option description and add sample code to the docs.

Related: #13467

@JackBoosY JackBoosY added category:port-bug The issue is with a library, which is something the port should already support 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 Jul 30, 2021
@JackBoosY
Copy link
Contributor Author

JackBoosY commented Jul 30, 2021

cc @wrobelda, can you please check MAYBE_UNUSED_VARIABLES's values in your opened PRs?

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

After committing all other changes, the version database must be updated
git add -u && git commit
git checkout fa1bbe097b26678e3fd992173b62279c071c422b -- versions
./vcpkg x-add-version --all
Diff
diff --git a/versions/v-/vcpkg-cmake.json b/versions/v-/vcpkg-cmake.json
index 87ddd66..086edd0 100644
--- a/versions/v-/vcpkg-cmake.json
+++ b/versions/v-/vcpkg-cmake.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "8d70d64792b10b091a27d19372db25cfb74d9e9c",
+      "git-tree": "c6df7e0faeda9e783175746c7c440c9bc2bdb111",
       "version-date": "2021-07-30",
       "port-version": 0
     },

@JackBoosY JackBoosY added the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Jul 30, 2021
@JackBoosY
Copy link
Contributor Author

Need to check the related warning message after pipeline test.

@JackBoosY
Copy link
Contributor Author

Question: should we also add the following requirement in https://github.com/microsoft/vcpkg/blob/master/docs/maintainers/maintainer-guide.md#build-techniques?

@PhoebeHui PhoebeHui added info:reviewed Pull Request changes follow basic guidelines and removed requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. labels Aug 3, 2021
@strega-nil-ms strega-nil-ms merged commit b7f99c3 into microsoft:master Aug 3, 2021
@JackBoosY JackBoosY deleted the dev/jack/fix-MAYBE_UNUSED_VARIABLES branch August 4, 2021 01:57
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 category:port-bug The issue is with a library, which is something the port should already support info:internal This PR or Issue was filed by the vcpkg team. info:reviewed Pull Request changes follow basic guidelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants