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 notice about how to export unofficial CMake targets. #23041

Merged
merged 3 commits into from
Feb 11, 2022

Conversation

BillyONeal
Copy link
Member

Adds documentation about how to add CMake targets when upstream does not provide such exported targets.

@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 Feb 11, 2022
Copy link
Contributor

@strega-nil-ms strega-nil-ms left a comment

Choose a reason for hiding this comment

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

the wording could probably be better from me as well, but this is my first try

docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
docs/maintainers/maintainer-guide.md Outdated Show resolved Hide resolved
Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
@BillyONeal
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@BillyONeal BillyONeal merged commit 6f1d72a into microsoft:master Feb 11, 2022
@BillyONeal BillyONeal deleted the unofficial-targets branch February 11, 2022 01:12
@dg0yt
Copy link
Contributor

dg0yt commented Feb 11, 2022

This effectively puts the unofficial targets into the reported usage. So sort-of still promoting the lock-in even if alternatives exists (Find module, pkg-config module).

Probably there are port which lack the ::<port>:: namespace part. This could be a post-install check.

@dg0yt
Copy link
Contributor

dg0yt commented Feb 11, 2022

In some cases it is necessary to export private API (Qt, poppler). There might be a hint how to use EXPORT_NAME to modify exported names.

+set_target_properties(poppler PROPERTIES EXPORT_NAME poppler-private)

@BillyONeal
Copy link
Member Author

This effectively puts the unofficial targets into the reported usage. So sort-of still promoting the lock-in even if alternatives exists (Find module, pkg-config module).

This whole section is "if you are adding CMake bindings" which we generally only do if there is no such thing present.

Probably there are port which lack the ::<port>:: namespace part. This could be a post-install check.

Probably not worth breaking anything already in the catalog. We added these docs primarily so that we have something to link to on what we want when people ask.

ekilmer added a commit to ekilmer/vcpkg that referenced this pull request Feb 15, 2022
* master: (54 commits)
  [imgui] Update to 1.87 [implot] Update to 0.13 (microsoft#22988)
  [nu-book-zxing-cpp] New port  (microsoft#22657)
  [librabbitmq] Update to 0.11.0 (microsoft#23037)
  [doc] Add doc for `supports` expression `staticcrt` (microsoft#23079)
  [doctest] Update to 2.4.8 (microsoft#23081)
  [log4cplus] Remove unneeded catch dependency (microsoft#23066)
  [Azure SDK] Update vcpkg ports for Feb Release (microsoft#23080)
  [Freerdp] Update to 2.5.0 (microsoft#23095)
  Update vcpkg-tool to 2022-02-11 (microsoft#23059)
  Minor bugfixes to MacOS deployment readme. (microsoft#23062)
  [ci.baseline.txt] Skip colmap on osx due to metis conflict (microsoft#23047)
  [gtkmm] update to 4.6.0 (microsoft#23024)
  [faiss] Update to 1.7.2 (microsoft#22705)
  [ocilib] Disable warning C4191 (microsoft#23028)
  [polyhook2] Update to latest  (microsoft#23044)
  Add notice about how to export unofficial CMake targets. (microsoft#23041)
  [Spirv reflect] Add new port (microsoft#22295)
  [easyhook] Update target .NET Framework version to 4.7.2. (microsoft#23040)
  [gh suggestions] change license link, make it details (microsoft#22946)
  [field3d] Remove port (microsoft#22463)
  ...
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants