@@ -219,16 +219,18 @@ script is used by swift.org's CI to produce snapshots and can allow for one to
219219locally reproduce such builds for development or distribution purposes. E.x.:
220220
221221```
222- $ ./utils/build-toolchain $TOOLCHAIN_PREFIX
222+ $ ./utils/build-toolchain $BUNDLE_PREFIX
223223```
224224
225- where `` $TOOLCHAIN_PREFIX `` is a string that will be prepended to the swift
226- package name in the produced tar ball. For instance, if `` $TOOLCHAIN_PREFIX ``
227- was `` macOS `` , the produced archive will have the name
228- `` swift-macOS.tar.gz `` .
225+ where `` $BUNDLE_PREFIX `` is a string that will be prepended to the build
226+ date to give the bundle identifier of the toolchain's `` Info.plist `` . For
227+ instance, if `` $BUNDLE_PREFIX `` was `` com.example `` , the toolchain
228+ produced will have the bundle identifier `` com.example.YYYYMMDD `` . It
229+ will be created in the directory you run the script with a filename
230+ of the form: `` swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz `` .
229231
230- Beyond building the toolchain, `` build-toolchain `` also supports the following
231- (non-exhaustive) set of useful options::
232+ Beyond building the toolchain, `` build-toolchain `` also supports the
233+ following (non-exhaustive) set of useful options::
232234
233235- `` --dry-run `` : Perform a dry run build. This is off by default.
234236- `` --test `` : Test the toolchain after it has been compiled. This is off by default.
@@ -246,8 +248,17 @@ On macOS if one wants to install such a toolchain into Xcode:
246248 ` ~/Library/Developer/Toolchains/ ` . E.x.:
247249
248250```
249- $ tar -xzf swift-macOS.tar.gz -C /
250- $ tar -xzf swift-macOS.tar.gz -C ~/
251+ $ sudo tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz -C /
252+ $ tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz -C ~/
253+ ```
254+
255+ The script also generates an archive containing debug symbols which
256+ can be installed over the main archive allowing symbolication of any
257+ compiler crashes.
258+
259+ ```
260+ $ sudo tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx-symbols.tar.gz -C /
261+ $ tar -xzf swift-LOCAL-YYYY-MM-DD-a-osx-symbols.tar.gz -C ~/
251262```
252263
2532642 . Specify the local toolchain for Xcode's use via ` Xcode->Toolchains ` .
0 commit comments