Skip to content

Commit 60aabbe

Browse files
Rename --linux-distribution* to just --distribution*, fixup README and typo in GeneratorError.unknownLinuxDistribution
1 parent 51a5730 commit 60aabbe

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ platforms and environments, supply the `--target` flag with the full target trip
132132
The Linux distribution name and version can also be passed to change from the default of Ubuntu Jammy:
133133

134134
```bash
135-
swift run swift-sdk-generator make-linux-sdk --linux-distribution-name ubuntu --linux-distribution-version noble
135+
swift run swift-sdk-generator make-linux-sdk --distribution-name ubuntu --distribution-version 24.04
136136
```
137137

138138
### Host Toolchain
@@ -144,13 +144,13 @@ and are likely not using the Swift OSS toolchain to build and run Swift projects
144144
is included by *default*. This default behavior can be changed by passing `--no-host-toolchain`:
145145

146146
```bash
147-
swift run swift-sdk-generator make-linux-sdk --no-host-toolchain --target x86_64
147+
swift run swift-sdk-generator make-linux-sdk --no-host-toolchain --target-arch x86_64
148148
```
149149

150150
Or, if on Linux, and desiring to generate the Swift SDK with the host toolchain included, add `--host-toolchain`:
151151

152152
```bash
153-
swift run swift-sdk-generator make-linux-sdk --host-toolchain --target aarch64
153+
swift run swift-sdk-generator make-linux-sdk --host-toolchain --target-arch aarch64
154154
```
155155

156156
## Building an SDK from a container image
@@ -162,10 +162,10 @@ Jammy image:
162162
```
163163
swift run swift-sdk-generator make-linux-sdk --with-docker
164164
```
165-
To build a RHEL images, use the `--linux-distribution-name` option.
165+
To build a RHEL images, use the `--distribution-name` option.
166166
The following command will build a `ubi9`-based image:
167167
```
168-
swift run swift-sdk-generator make-linux-sdk --with-docker --linux-distribution-name rhel
168+
swift run swift-sdk-generator make-linux-sdk --with-docker --distribution-name rhel
169169
```
170170

171171
You can also specify the base container image by name:
@@ -175,7 +175,7 @@ swift run swift-sdk-generator make-linux-sdk --from-container-image swift:5.9-ja
175175
```
176176

177177
```
178-
swift run swift-sdk-generator make-linux-sdk --with-docker --linux-distribution-name rhel --from-container-image swift:5.9-rhel-ubi9
178+
swift run swift-sdk-generator make-linux-sdk --with-docker --distribution-name rhel --from-container-image swift:5.9-rhel-ubi9
179179
```
180180

181181
### Including extra Linux libraries

Sources/GeneratorCLI/GeneratorCLI.swift

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -214,16 +214,16 @@ extension GeneratorCLI {
214214
""",
215215
transform: LinuxDistribution.Name.init(nameString:)
216216
)
217-
var linuxDistributionName = LinuxDistribution.Name.ubuntu
217+
var distributionName = LinuxDistribution.Name.ubuntu
218218

219219
@Option(
220220
help: """
221221
Version of the Linux distribution used as a target platform.
222-
Available options for Ubuntu: `20.04`, `22.04` (default when `--linux-distribution-name` is `ubuntu`), `24.04`.
223-
Available options for RHEL: `ubi9` (default when `--linux-distribution-name` is `rhel`).
222+
Available options for Ubuntu: `20.04`, `22.04` (default when `--distribution-name` is `ubuntu`), `24.04`.
223+
Available options for RHEL: `ubi9` (default when `--distribution-name` is `rhel`).
224224
"""
225225
)
226-
var linuxDistributionVersion: String?
226+
var distributionVersion: String?
227227

228228
func deriveTargetTriple(hostTriple: Triple) -> Triple {
229229
if let target = generatorOptions.target {
@@ -245,17 +245,17 @@ extension GeneratorCLI {
245245
"deprecated: Please explicitly specify the subcommand to run. For example: $ swift-sdk-generator make-linux-sdk"
246246
)
247247
}
248-
let linuxDistributionDefaultVersion: String
249-
switch self.linuxDistributionName {
248+
let distributionDefaultVersion: String
249+
switch self.distributionName {
250250
case .rhel:
251-
linuxDistributionDefaultVersion = "ubi9"
251+
distributionDefaultVersion = "ubi9"
252252
case .ubuntu:
253-
linuxDistributionDefaultVersion = "22.04"
253+
distributionDefaultVersion = "22.04"
254254
}
255-
let linuxDistributionVersion =
256-
self.linuxDistributionVersion ?? linuxDistributionDefaultVersion
255+
let distributionVersion =
256+
self.distributionVersion ?? distributionDefaultVersion
257257
let linuxDistribution = try LinuxDistribution(
258-
name: linuxDistributionName, version: linuxDistributionVersion)
258+
name: distributionName, version: distributionVersion)
259259
let hostTriple = try self.generatorOptions.deriveHostTriple()
260260
let targetTriple = self.deriveTargetTriple(hostTriple: hostTriple)
261261

Sources/SwiftSDKGenerator/SystemUtils/GeneratorError.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ extension GeneratorError: CustomStringConvertible {
4040
return "Process launched with \(commandInfo) failed with exit code \(exitCode)"
4141
case let .unknownLinuxDistribution(name, version):
4242
return
43-
"Linux distribution `\(name)`\(version.map { " with version \($0)" } ?? "")` is not supported by this generator."
43+
"Linux distribution `\(name)`\(version.map { " with version `\($0)`" } ?? "") is not supported by this generator."
4444
case let .unknownMacOSVersion(version):
4545
return "macOS version `\(version)` is not supported by this generator."
4646
case let .unknownCPUArchitecture(cpu):

Tests/SwiftSDKGeneratorTests/EndToEndTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ final class RepeatedBuildTests: XCTestCase {
138138
do {
139139
try await Shell.run("docker ps")
140140
possibleArguments.append(
141-
"--with-docker --linux-distribution-name rhel --linux-distribution-version ubi9")
141+
"--with-docker --distribution-name rhel --distribution-version ubi9")
142142
} catch {
143143
self.logger.warning(
144144
"Docker CLI does not seem to be working, skipping tests that involve Docker.")
@@ -198,7 +198,7 @@ struct SDKConfiguration {
198198
"--swift-version \(swiftVersion)-RELEASE",
199199
testLinuxSwiftSDKs ? "--host \(hostArch!)-unknown-linux-gnu" : nil,
200200
"--target \(architecture)-unknown-linux-gnu",
201-
"--linux-distribution-name \(linuxDistributionName)",
201+
"--distribution-name \(linuxDistributionName)",
202202
].compactMap { $0 }.joined(separator: " ")
203203
}
204204
}

0 commit comments

Comments
 (0)