[6.0] Symbol graph cherry picks #7659
Merged
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
In order to extract symbol graphs for modules with transitive imports on C++ modules we need parse headers in C++ interop mode using the option: `-cxx-interoperability-mode=default`. This commit updates `swift-symbolgraph-extract` to pass the option when there is a C++ module in the import graph. This option is a new addition to `swift-symbolgraph-extract` added in swiftlang/swift#73963. Prior to this option's introduction, extracting the symbol graph for C++ dependent modules would fail with an error similar to: "unknown type name 'namespace'". With this SwiftPM commit and `swift-symbolgraph-extract` _prior_ to swiftlang/swift#73963, users will instead see an argument parsing error like: "unknown option -cxx-interoperability-mode". With this change and `swift-symbolgraph-extract` change in swiftlang/swift#73963, the symbol graph is extracted properly.
Fixes an architecture and implementation bug where the include paths for `swift-symbolgraph-extract` were being determined inside build plan instead of by the target build description. This bug resulted in the wrong set of paths being determined. The new code moves the path determination logic into the proper target build descriptions and releverages the already computed include paths. The result of this is symbol graphs can be generated for Swift and C targets properly now without duplicate module in the search paths and with correct `-fmodule` usage.
|
@swift-ci test |
bnbarham
approved these changes
Jun 12, 2024
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.
Explanation: Updates
swift package dump-symbol-graphto pass the correct set of include and cxx interoperability mode flags. This fixes a bug where were are unable to extract the symbol graph from swiftmodules with transitive cxx modules because we parsed cxx headers as c headers.With these changes
swift-mmiois able to generate symbol graphs and documentation using theswift package dump-symbol-graphandswift package generate-documentationcommands.Scope: Documentation generation
Issue:
Original PR: #7610, #7621
Risk: Low
Testing: CI & at desk usage directly and via SwiftPM
Reviewer: @xedin