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

[poly2tri] Set policy CMP0063 to NEW #27263

Merged
merged 3 commits into from
Oct 19, 2022

Conversation

kduske
Copy link
Contributor

@kduske kduske commented Oct 16, 2022

Describe the pull request

  • What does your PR fix?

Linker warnings about conflicting visibility settings if poly2tri, which is built as a static library, is pulled into a build as an indirect dependency of a shared library. An example of such a configuration is assimp, which depends on poly2tri, and can be built as a dynamic library on macOS.

Policy CMP0063 enables CMake to set the symbol visibility of static libraries to avoid this problem.

  • Which triplets are supported/not supported? Have you updated the CI baseline?

    all, No

  • Does your PR follow the maintainer guide?

    Yes, to the best of my knowledge.

  • If you have added/updated a port: Have you run ./vcpkg x-add-version --all and committed the result?

No, the maintainer guide says to do that only when updating multiple ports at the same time.

This change enables CMake to set the symbol visibility of static
libraries. Since poly2tri is compiled as a static library, without this
change, it can lead to linker warnings about conflicting visibility
settings if it is itself linked into a dynamic library.
@kduske
Copy link
Contributor Author

kduske commented Oct 16, 2022

@microsoft-github-policy-service agree]

@kduske
Copy link
Contributor Author

kduske commented Oct 16, 2022

@microsoft-github-policy-service agree

@@ -1,5 +1,9 @@
cmake_minimum_required(VERSION 3.0)
Copy link
Contributor

Choose a reason for hiding this comment

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

Just push this to 3.15 or higher. (vcpkg internally has 3.24)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you mean instead of or in addition to setting the policy?

Copy link
Contributor

@dg0yt dg0yt Oct 17, 2022

Choose a reason for hiding this comment

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

Do you mean instead of or in addition to setting the policy?

"instead".
By requiring a particular version, CMake sets all policies introduced up to that version to NEW. Version 3.15 implicitly includes CMP0063 from CMake 3.3.
(PS Bumping cmake_minimum_required may come with side effects, but @Neumann-A probably hopes for vcpkg-CI to catch them.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately that does not fix the issue. As per the documentation, this particular policy defaults to OLD if not set even on 3.25.

Copy link
Contributor

Choose a reason for hiding this comment

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

CMake version 3.24.2 warns when the policy is not set and uses OLD behavior

do you get the warning ? Are the properties even getting set?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I get the warning if I set

set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_VISIBILITY_INLINES_HIDDEN TRUE)

in poly2tri's CMakeList.txt, but not the policy. And this reveals an error I made in the initial PR, where I did not set the visibility preset properties. I'm having a bit of trouble with my setup locally so I did not notice that it doesn't work when I only set the policy.

Here's the exact warning I get:

CMake Warning (dev) at /Users/kristian/Documents/Code/TrenchBroom/vcpkg/scripts/buildsystems/vcpkg.cmake:613 (_add_library):
  Policy CMP0063 is not set: Honor visibility properties for all target
  types.  Run "cmake --help-policy CMP0063" for policy details.  Use the
  cmake_policy command to set the policy and suppress this warning.

  Target "poly2tri" of type "STATIC_LIBRARY" has the following visibility
  properties set for CXX:

    CXX_VISIBILITY_PRESET
    VISIBILITY_INLINES_HIDDEN

  For compatibility CMake is not honoring them for this target.
Call Stack (most recent call first):
  CMakeLists.txt:38 (add_library)
This warning is for project developers.  Use -Wno-dev to suppress it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll push some fixup to address all these issues.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, 06c684f should fix these issues now. I have not updated the required cmake version to keep the changes minimal. I think it's not necessary to bump it for this. Let me know if you think otherwise and I'll change it.

@LilyWangLL LilyWangLL self-assigned this Oct 17, 2022
@LilyWangLL LilyWangLL added the category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist label Oct 17, 2022
github-actions[bot]
github-actions bot previously approved these changes Oct 17, 2022
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.

Use the version scheme "version-date" instead of "version-string" in port "poly2tri".

You have modified or added at least one vcpkg.json where you should check the license field.

If you feel able to do so, please consider adding a "license" field to the following files:

  • ports/poly2tri/vcpkg.json

Valid values for the license field can be found in the documentation

ports/poly2tri/vcpkg.json Outdated Show resolved Hide resolved
Set default symbol visibility to hidden

Policy CMP0063 enables CMake to set the symbol visibility of static
libraries. Since poly2tri is compiled as a static library, without this
change, the default symbol visibility cannot be set, leading to linker
warnings about conflicting visibility settings if poly2tri is itself
linked into a dynamic library.
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.

You have modified or added at least one vcpkg.json where you should check the license field.

If you feel able to do so, please consider adding a "license" field to the following files:

  • ports/poly2tri/vcpkg.json

Valid values for the license field can be found in the documentation

@LilyWangLL LilyWangLL added the info:reviewed Pull Request changes follow basic guidelines label Oct 18, 2022
@BillyONeal
Copy link
Member

Thanks for running down that extremely bizarre policy thing

@BillyONeal BillyONeal merged commit 6ee2fa9 into microsoft:master Oct 19, 2022
BillyONeal added a commit to BillyONeal/vcpkg that referenced this pull request Nov 1, 2022
…0-17, he started applying use of the "embedded VERSION" feature microsoft/vcpkg-tool#717 to PRs on merge.

@dg0yt points out that this use should be accompanied by a call to vcpkg_minimum_required, in https://github.com/microsoft/vcpkg/pull/27594/files#r1010641672

This is an audit of everything merged in that time and whether it needs to gain that.

microsoft#27561 No VERSION
microsoft#27525 No VERSION
microsoft#27554 Already has vcpkg_minimum_required
microsoft#27536 No VERSION
microsoft#27562 No VERSION
microsoft#24914 Fixed here
microsoft#27547 No VERSION
microsoft#27502 No VERSION
microsoft#27497 No VERSION
microsoft#27317 No VERSION
microsoft#27288 No VERSION
microsoft#27509 No VERSION
microsoft#27504 No VERSION
microsoft#27514 No VERSION
microsoft#27501 No VERSION
microsoft#27495 No VERSION
microsoft#27488 No VERSION
microsoft#27499 No VERSION
microsoft#27378 No VERSION
microsoft#27376 Fixed here
microsoft#27373 No VERSION
microsoft#27045 No VERSION
microsoft#27521 No VERSION
microsoft#27453 No VERSION
microsoft#27481 No VERSION
microsoft#27511 No VERSION
microsoft#27490 No VERSION
microsoft#27510 No VERSION
microsoft#27496 No VERSION
microsoft#27503 No VERSION
microsoft#27485 No VERSION
microsoft#27484 No VERSION
microsoft#27483 No VERSION
microsoft#27459 No VERSION
microsoft#27369 No VERSION
microsoft#27489 No VERSION
microsoft#26594 No VERSION
microsoft#27465 No VERSION
microsoft#27456 No VERSION
microsoft#27425 No VERSION
microsoft#27464 Fixed here
microsoft#27406 No VERSION
microsoft#27398 No VERSION
microsoft#27240 No VERSION
microsoft#27450 No VERSION
microsoft#27463 No VERSION
microsoft#27462 No VERSION
microsoft#27448 No VERSION
microsoft#27440 No VERSION
microsoft#27435 No VERSION
microsoft#27424 No VERSION
microsoft#27414 No VERSION
microsoft#27412 No VERSION
microsoft#27380 No VERSION
microsoft#27343 No VERSION
microsoft#27342 No VERSION
microsoft#27367 No VERSION
microsoft#27226 No VERSION
microsoft#27320 No VERSION
microsoft#26923 No VERSION
microsoft#27284 No VERSION
microsoft#27433 No VERSION
microsoft#27314 VERSION got *removed*
microsoft#27335 No VERSION
microsoft#27370 No VERSION
microsoft#27324 No VERSION
microsoft#27391 No VERSION
microsoft#27388 No VERSION
microsoft#27396 No VERSION
microsoft#27404 No VERSION
microsoft#27413 No VERSION
microsoft#27417 No VERSION
microsoft#27427 No VERSION
microsoft#27428 No VERSION
microsoft#27368 No VERSION
microsoft#27307 No VERSION
microsoft#27415 Fixed here.
microsoft#27371 Fixed here.
microsoft#27323 No VERSION
microsoft#27352 No VERSION
microsoft#27347 No VERSION
microsoft#27366 No VERSION
microsoft#27361 No VERSION
microsoft#27359 No VERSION
microsoft#27358 No VERSION
microsoft#27355 No VERSION
microsoft#27331 No VERSION
microsoft#24615 No VERSION
microsoft#27325 No VERSION
microsoft#24861 No VERSION
microsoft#27354 No VERSION
microsoft#27346 No VERSION
microsoft#27345 No VERSION
microsoft#27218 No VERSION
microsoft#27329 No VERSION
microsoft#27326 No VERSION
microsoft#27321 No VERSION
microsoft#27312 No VERSION
microsoft#27297 No VERSION
microsoft#27336 No VERSION
microsoft#27225 No VERSION
microsoft#27339 No VERSION
microsoft#27302 No VERSION
microsoft#27295 No VERSION
microsoft#27233 No VERSION
microsoft#27313 No VERSION
microsoft#27237 No VERSION
microsoft#27250 No VERSION
microsoft#27263 No VERSION
microsoft#27266 No VERSION
microsoft#27272 No VERSION
microsoft#27287 No VERSION
microsoft#27282 No VERSION
microsoft#27294 No VERSION
microsoft#27228 No VERSION
microsoft#27163 No VERSION
microsoft#26817 No VERSION
microsoft#27286 No VERSION
microsoft#27274 No VERSION
microsoft#27276 No VERSION
microsoft#27232 No VERSION
microsoft#27221 No VERSION
microsoft#27215 No VERSION
microsoft#27166 No VERSION
microsoft#27239 No VERSION
microsoft#27246 No VERSION
microsoft#27268 No VERSION
microsoft#27259 No VERSION
microsoft#27238 No VERSION
microsoft#27224 No VERSION
microsoft#27203 No VERSION
microsoft#27124 No VERSION
JavierMatosD pushed a commit that referenced this pull request Nov 8, 2022
* When @BillyONeal started being the on-call vcpkg maintainer on 2022-10-17, he started applying use of the "embedded VERSION" feature microsoft/vcpkg-tool#717 to PRs on merge.

@dg0yt points out that this use should be accompanied by a call to vcpkg_minimum_required, in https://github.com/microsoft/vcpkg/pull/27594/files#r1010641672

This is an audit of everything merged in that time and whether it needs to gain that.

#27561 No VERSION
#27525 No VERSION
#27554 Already has vcpkg_minimum_required
#27536 No VERSION
#27562 No VERSION
#24914 Fixed here
#27547 No VERSION
#27502 No VERSION
#27497 No VERSION
#27317 No VERSION
#27288 No VERSION
#27509 No VERSION
#27504 No VERSION
#27514 No VERSION
#27501 No VERSION
#27495 No VERSION
#27488 No VERSION
#27499 No VERSION
#27378 No VERSION
#27376 Fixed here
#27373 No VERSION
#27045 No VERSION
#27521 No VERSION
#27453 No VERSION
#27481 No VERSION
#27511 No VERSION
#27490 No VERSION
#27510 No VERSION
#27496 No VERSION
#27503 No VERSION
#27485 No VERSION
#27484 No VERSION
#27483 No VERSION
#27459 No VERSION
#27369 No VERSION
#27489 No VERSION
#26594 No VERSION
#27465 No VERSION
#27456 No VERSION
#27425 No VERSION
#27464 Fixed here
#27406 No VERSION
#27398 No VERSION
#27240 No VERSION
#27450 No VERSION
#27463 No VERSION
#27462 No VERSION
#27448 No VERSION
#27440 No VERSION
#27435 No VERSION
#27424 No VERSION
#27414 No VERSION
#27412 No VERSION
#27380 No VERSION
#27343 No VERSION
#27342 No VERSION
#27367 No VERSION
#27226 No VERSION
#27320 No VERSION
#26923 No VERSION
#27284 No VERSION
#27433 No VERSION
#27314 VERSION got *removed*
#27335 No VERSION
#27370 No VERSION
#27324 No VERSION
#27391 No VERSION
#27388 No VERSION
#27396 No VERSION
#27404 No VERSION
#27413 No VERSION
#27417 No VERSION
#27427 No VERSION
#27428 No VERSION
#27368 No VERSION
#27307 No VERSION
#27415 Fixed here.
#27371 Fixed here.
#27323 No VERSION
#27352 No VERSION
#27347 No VERSION
#27366 No VERSION
#27361 No VERSION
#27359 No VERSION
#27358 No VERSION
#27355 No VERSION
#27331 No VERSION
#24615 No VERSION
#27325 No VERSION
#24861 No VERSION
#27354 No VERSION
#27346 No VERSION
#27345 No VERSION
#27218 No VERSION
#27329 No VERSION
#27326 No VERSION
#27321 No VERSION
#27312 No VERSION
#27297 No VERSION
#27336 No VERSION
#27225 No VERSION
#27339 No VERSION
#27302 No VERSION
#27295 No VERSION
#27233 No VERSION
#27313 No VERSION
#27237 No VERSION
#27250 No VERSION
#27263 No VERSION
#27266 No VERSION
#27272 No VERSION
#27287 No VERSION
#27282 No VERSION
#27294 No VERSION
#27228 No VERSION
#27163 No VERSION
#26817 No VERSION
#27286 No VERSION
#27274 No VERSION
#27276 No VERSION
#27232 No VERSION
#27221 No VERSION
#27215 No VERSION
#27166 No VERSION
#27239 No VERSION
#27246 No VERSION
#27268 No VERSION
#27259 No VERSION
#27238 No VERSION
#27224 No VERSION
#27203 No VERSION
#27124 No VERSION

* Also add libcanberra
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist info:reviewed Pull Request changes follow basic guidelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants