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

[5.7] use new ivar/macro symbol kinds #156

Merged
merged 4 commits into from
Apr 23, 2022

Conversation

QuietMisdreavus
Copy link
Contributor

This is a cherry-pick of #152 onto release/5.7.

Explanation: A change in SymbolKit (swiftlang/swift-docc-symbolkit#31) is adding new symbol kinds: ivar and macro. This change updates DocC to handle these new symbols and curate them within rendered documentation.

Scope: Adds new behavior to load and curate new symbol types. Existing documentation should render with no change in behavior.

Radar: rdar://92124246

Risk: Low. This is a small enhancement without changing existing behavior for loading and curating symbols.

Testing: A new automated test has been added to ensure that the new symbol kinds can be loaded and organized into the documentation hierarchy correctly.

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

Package.swift Outdated
@@ -124,7 +124,7 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
.package(name: "swift-markdown", url: "https://github.com/apple/swift-markdown.git", .branch("main")),
.package(name: "CLMDB", url: "https://github.com/apple/swift-lmdb.git", .branch("main")),
.package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "1.0.1")),
.package(name: "SymbolKit", url: "https://github.com/apple/swift-docc-symbolkit", .branch("main")),
.package(name: "SymbolKit", url: "https://github.com/apple/swift-docc-symbolkit", .branch("revert-25-revert-23-5.7/objc-kinds")),
Copy link
Contributor

@ethan-kusters ethan-kusters Apr 22, 2022

Choose a reason for hiding this comment

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

When we update this to point at release/5.7 can we also update CLMDB and swift-markdown to point at release/5.7 and re-resolve dependencies? This shouldn't change the commit hash since main and release/5.7 point to the same commit but we should still be pointing to the correct branch here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah! I can do that once i land the SymbolKit PR.

@QuietMisdreavus
Copy link
Contributor Author

I've updated the PR to point back at SymbolKit's release/5.7 branch, now that swiftlang/swift-docc-symbolkit#31 has landed. I've also updated Package.swift to point to CLMDB's and swift-markdown's release/5.7 branches as well. Swift-Markdown has had some commits in both main and release/5.7 that haven't been reflected in an update here, so i made sure to keep the same commit in the Package.resolved file. That update can happen in a separate PR.

@swift-ci Please test

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test macOS

@QuietMisdreavus QuietMisdreavus merged commit 2d9308f into swiftlang:release/5.7 Apr 23, 2022
@QuietMisdreavus QuietMisdreavus deleted the 5.7/ivar-macro branch April 23, 2022 01:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants