Add include dir from a clang module into the build args in diagnose-api-breaking-changes command.
#8209
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Each clang module has public `include` dir. When building current module then it typically works as-is, but when a module has non-standard source location, then explicit include of `include` is necessary.
yyvch
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
francescomikulis,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv and
bkhouri
as code owners
yyvch
commented
Jan 10, 2025
plemarquand
approved these changes
Jan 15, 2025
|
@swift-ci please test |
jakepetroules
approved these changes
Jan 21, 2025
bkhouri
pushed a commit
that referenced
this pull request
Jan 23, 2025
- Description: Fix build error for `diagnose-api-breaking-changes` command when C code is in non-standard location - Scope: Package - Risk: Low - Testing: New test for this specific scenario. However, the test suite is deactivated in 6.1 unless [#8196](#8196) is cherry-picked too. - Issue: #8073 - Cherry-picked from: #8209 - Author: @yyvch - Reviewers: @plemarquand @jakepetroules
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #8073: Update include paths for clang module in
diagnose-api-breaking-changescommand.Motivation:
Swift package manager's command
diagnose-api-breaking-changesis a wrapper on top ofswift-api-digester. Purpose ofswift-api-digesteris to detect API incompatible changes between two revisions of code.diagnose-api-breaking-changesmakes it more convenient to use with packages and does a few things under the hood:swift-api-digesterto compare current package to the baseline commitswift-api-digesterwith necessary build flags determined by toolchain, configuration and environment@PeterAdams-A reported in #8073 that
swift-api-digesterfailed to build a baseline commit for a specific package with vendored C library. This PR resolves the issue.Modifications:
Turns out,
diagnose-api-breaking-changeswas missing some include paths which were necessary for the package to be built. The PR corrects that and adds a new include path for CLang targets. The build arguments are used only byswift-api-digesterand do not impact other commands. I distilled the failing scenario to a test case and added it toAPIDifftests.Modifications:
includedir. When building current module then it typically works as-is, but when a module has non-standard source location, then explicit include ofincludeis necessary.diagnose-api-breaking-changescan check API compatibility for a package with non-default source location and include files.Result:
diagnose-api-breaking-changesdoesn't error out on such packages