Skip to content

Runtimes: support installing the swiftdoc for the modules #81425

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 13, 2025
Merged

Runtimes: support installing the swiftdoc for the modules #81425

merged 2 commits into from
May 13, 2025

Conversation

compnerd
Copy link
Member

@compnerd compnerd commented May 9, 2025

Add support to install the swiftdoc into the installed image. This is required to allow us to package up the runtime on Windows.

@compnerd
Copy link
Member Author

compnerd commented May 9, 2025

@swift-ci please smoke test

etcwilde
etcwilde reviewed May 9, 2025
View reviewed changes
Copy link
Contributor

@etcwilde etcwilde left a comment

Choose a reason for hiding this comment

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

Do we want to make it a separate function or should we roll it into part of the module installation? Are there libraries where we don't want to include the swiftdoc when we do include the module?

@compnerd
Copy link
Member Author

compnerd commented May 10, 2025 •
edited
Loading

Do we want to make it a separate function or should we roll it into part of the module installation? Are there libraries where we don't want to include the swiftdoc when we do include the module?

Good question. I don't know the best answer here. I think that we do always want to install the swiftdoc. However, I don't think that this should be part of the emit_swift_interface call. We could rename that to install_swift_module and merge the two though.

I can see the value in keeping it separate - install(TARGETS ...) will need to have a flag to install the swift doc I imagine. I can also see the value in merging it - it is nice to have a single install module call that takes care of all the details.

@compnerd
Copy link
Member Author

@swift-ci please test Windows platform

@compnerd
Copy link
Member Author

@swift-ci please smoke test

compnerd added 2 commits May 12, 2025 17:34
@compnerd
Runtimes: refactor swift interface installation
0f2ed0e 
Extract the `install_swift_interface` function into a new file. This
is always invoked to perform the installation of the Swift interfaces as
well as the binary module. Additionally, it prepares for a future
refactoring which will also install the swift documentation interface.
@compnerd
Runtimes: install the .swiftdoc interface as well
babfa09 
This is part of the development component for the module and is part of
the interface definition. This content is consumed by the user during
development.
@compnerd
Copy link
Member Author

@swift-ci please smoke test

@compnerd compnerd enabled auto-merge May 13, 2025 00:37
@compnerd compnerd merged commit b5a31e3 into swiftlang:main May 13, 2025
3 checks passed
@compnerd compnerd deleted the documentation branch May 13, 2025 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@etcwilde etcwilde etcwilde approved these changes

@edymtt edymtt Awaiting requested review from edymtt edymtt is a code owner

@justice-adams-apple justice-adams-apple Awaiting requested review from justice-adams-apple justice-adams-apple is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@compnerd @etcwilde