Document how to use Swift Packages on Linux #313
Conversation
This file contains 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
chinedufn
reviewed
Jan 30, 2025
Comment on lines
+262
to
+270
| * this ensures that the flags that are normally passed via swiftc are forwarded during swift-build | ||
| * Since the path of the resulting rust library "target/debug" depends on the build type, you can set a global variable like this: | ||
| ```swift | ||
| #if DEBUG | ||
| let buildType = "debug" | ||
| #else | ||
| let buildType = "release" | ||
| #endif | ||
| ``` |
There was a problem hiding this comment.
Where is this global variable set?
| linkerSettings: [ | ||
| .unsafeFlags([ | ||
| "generated/SwiftBridgeCore.swift", "generated/proj-rs/proj-rs.swift", | ||
| "-import-objc-header", "bridging-header.h", "-Ltarget/debug", "-lcorpus", |
There was a problem hiding this comment.
Can we change this example so that it supports both debug and release builds
| linkerSettings: [ | ||
| .unsafeFlags([ | ||
| "generated/SwiftBridgeCore.swift", "generated/proj-rs/proj-rs.swift", | ||
| "-import-objc-header", "bridging-header.h", "-Ltarget/debug", "-lcorpus", |
There was a problem hiding this comment.
Let's explain what this -lcorpus flag does
| * Set up swift-bridge according to the guide (see chapter "swiftc and cargo") | ||
| * Link against swift-bridge and your library, like the one below: | ||
| ```swift | ||
| targets: [ |
There was a problem hiding this comment.
Let's paste a complete file, unless there are so many lines that it's hard to understand.
This helps the reader better orient themselves towards what they're looking at.
Also, say what this file is. Explicitly say that this is a Package.swift
i.e. "like the Package.swift file below:"
| # Usage on Linux | ||
| Usage on Linux is a little bit different than on macOS. This guide will help you set up SwiftPM and Cargo. The general workflow is: | ||
| * Set up Package.swift so that "cargo build" is called (You can use something like this here: "https://stackoverflow.com/questions/26971240/how-do-i-run-a-terminal-command-in-a-swift-script-e-g-xcodebuild" to invoke cargo during a swift build) | ||
| * Set up swift-bridge according to the guide (see chapter "swiftc and cargo") |
There was a problem hiding this comment.
Set up swift-bridge how? What does the user need to do? Everything in the guide? A couple things in the guide? Can be more explicit here.
|
|
||
| # Usage on Linux | ||
| Usage on Linux is a little bit different than on macOS. This guide will help you set up SwiftPM and Cargo. The general workflow is: | ||
| * Set up Package.swift so that "cargo build" is called (You can use something like this here: "https://stackoverflow.com/questions/26971240/how-do-i-run-a-terminal-command-in-a-swift-script-e-g-xcodebuild" to invoke cargo during a swift build) |
There was a problem hiding this comment.
Let's not depend on external sources.
Users should not need to hop around other links/sites/pages to figure out how this works, unless inlining the information is undesirable for some reason.
Let's instead just inline an example of what you mean here, vs. making the user go find and interpret a stackoverflow page.
| @@ -238,3 +233,38 @@ cd SwiftProject | |||
| swift run | |||
| # You should see "Hello from Rust!" in your terminal. | |||
| ``` | |||
|
|
|||
| # Usage on Linux | |||
| Usage on Linux is a little bit different than on macOS. This guide will help you set up SwiftPM and Cargo. The general workflow is: | |||
There was a problem hiding this comment.
Let's explicitly mention the ways that it is different.
So, up here instead of saying it's "a little bit different" just summarize the main way(s) that it is different.
Then your guide below walks the user through addressing those differences.
chinedufn
changed the title
chinedufn
added
the
linux-support
|
I just opened an issue about generating a (linux-compatible) SPM package: #315 |
|
FWIW, I tried this approach for the new testing harness, but I couldn't get it working. Package.swift: import PackageDescription
let package = Package(
name: "IntegrationTests",
targets: [
.target(
name: "Fixtures",
swiftSettings: [
.interoperabilityMode(.C),
.unsafeFlags([
"-import-objc-header", "Sources/Fixtures/bridge.h",
])
],
linkerSettings: [
// Link our rust static library...
.linkedLibrary("rust_fixtures"),
// And tell the linker where to look for it.
.unsafeFlags(["-L../target/debug"]),
]
),
.testTarget(
name: "Tests",
dependencies: ["Fixtures"]
)
]
)Sample output of |
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.
No description provided.