Skip to content

Commit 72f04b6

Browse files
authored
[docs]: update steps on building with containerization project (apple#1116)
- Closes apple#1095 - Just added a few more details about how to build with the local `containerization` dependency.
1 parent 3a0ad58 commit 72f04b6

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

‎BUILDING.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,19 @@ to prepare your build environment.
6666
```
6767

6868
> [!IMPORTANT]
69-
> If you are using Xcode, you will need to temporarily modify `Package.swift` instead of using `swift package edit`, using a path dependency in place of the versioned `container` dependency:
69+
> If you are using Xcode, do **not** run `swift package edit`. Instead, temporarily modify `Package.swift` to replace the versioned `containerization` dependency:
7070
>
71-
> ```swift
72-
> .package(path: "../containerization"),
73-
> ```
71+
> ```swift
72+
> .package(url: "https://github.com/apple/containerization.git", exact: Version(stringLiteral: scVersion)),
73+
> ```
74+
>
75+
> with the local path dependency:
76+
>
77+
> ```swift
78+
> .package(path: "../containerization"),
79+
> ```
80+
>
81+
> **Note:** If you have already run `swift package edit`, whether intentionally or by accident, follow the steps in the next section to restore the normal `containerization` dependency. Otherwise, the modified `Package.swift` file will not work, and the project may fail to build.
7482

7583
5. If you want `container` to use any changes you made in the `vminit` subproject of Containerization, update the system property to use the locally built init filesystem image:
7684

0 commit comments

Comments
 (0)