Skip to content

Commit 747b4a0

Browse files
authored
[docs] Document building stdlib/presets against a LKG snapshot
Also provided an example of how to do this to run the minimal macho preset.
1 parent 3dca0b6 commit 747b4a0

File tree

1 file changed

+44
-8
lines changed

1 file changed

+44
-8
lines changed

docs/ContinuousIntegration.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@
1111
- [Linting](#linting)
1212
- [Source Compatibility Testing](#source-compatibility-testing)
1313
- [Sourcekit Stress Testing](#sourcekit-stress-testing)
14-
- [Specific Preset Testing](#specific-preset-testing)
15-
- [Running Non-Executable Device Tests](#running-non-executable-device-tests)
1614
- [Build Swift Toolchain](#build-swift-toolchain)
15+
- [Build and Test Stdlib against Snapshot Toolchain](#build-and-test-stdlib-against-snapshot-toolchain)
16+
- [Specific Preset Testing](#specific-preset-testing)
17+
- [Specific Preset Testing against a Snapshot Toolchain](#specific-preset-testing-against-a-snapshot-toolchain)
18+
- [Running Non-Executable Device Tests using Specific Preset Testing](#running-non-executable-device-tests-using-specific-preset-testing)
19+
- [Build and Test the Minimal Freestanding Stdlib using Toolchain Specific Preset Testing](#build-and-test-the-minimal-freestanding-stdlib-using-toolchain-specific-preset-testing)
1720
- [Testing Compiler Performance](#testing-compiler-performance)
1821
- [Swift Community Hosted CI Pull Request Testing](#swift-community-hosted-ci-pull-request-testing)
1922
- [Cross Repository Testing](#cross-repository-testing)
@@ -154,6 +157,21 @@ Platform | Comment | Check Status
154157
------------ | ------- | ------------
155158
macOS platform | @swift-ci Please Sourcekit Stress test | Swift Sourcekit Stress Tester on macOS Platform
156159

160+
### Build Swift Toolchain
161+
162+
Platform | Comment | Check Status
163+
------------ | ------- | ------------
164+
macOS platform | @swift-ci Please Build Toolchain macOS Platform| Swift Build Toolchain macOS Platform
165+
Linux platform | @swift-ci Please Build Toolchain Linux Platform| Swift Build Toolchain Linux Platform
166+
167+
### Build and Test Stdlib against Snapshot Toolchain
168+
169+
To test/build the stdlib for a branch that changes only the stdlib using a last known good snapshot toolchain:
170+
171+
Platform | Comment | Check Status
172+
------------ | ------- | ------------
173+
macOS platform | @swift-ci Please test stdlib with toolchain| Swift Test stdlib with toolchain macOS Platform
174+
157175
### Specific Preset Testing
158176

159177
Platform | Comment | Check Status
@@ -169,7 +187,23 @@ preset=buildbot_incremental,tools=RA,stdlib=RD,smoketest=macosx,single-thread
169187
@swift-ci Please test with preset macOS
170188
```
171189

172-
### Running Non-Executable Device Tests
190+
191+
### Specific Preset Testing against a Snapshot Toolchain
192+
193+
One can also run an arbitrary preset against a snapshot toolchain
194+
195+
Platform | Comment | Check Status
196+
------------ | ------- | ------------
197+
macOS platform | preset=<preset> <br> @swift-ci Please test with toolchain and preset| Swift Test stdlib with toolchain macOS Platform (Preset)
198+
199+
For example:
200+
201+
```
202+
preset=$PRESET_NAME
203+
@swift-ci Please test with toolchain and preset
204+
```
205+
206+
### Running Non-Executable Device Tests using Specific Preset Testing
173207

174208
Using the specific preset testing, one can run non-executable device tests by
175209
telling swift-ci:
@@ -179,12 +213,14 @@ preset=buildbot,tools=RA,stdlib=RD,test=non_executable
179213
@swift-ci Please test with preset macOS
180214
```
181215

182-
### Build Swift Toolchain
216+
### Build and Test the Minimal Freestanding Stdlib using Toolchain Specific Preset Testing
183217

184-
Platform | Comment | Check Status
185-
------------ | ------- | ------------
186-
macOS platform | @swift-ci Please Build Toolchain macOS Platform| Swift Build Toolchain macOS Platform
187-
Linux platform | @swift-ci Please Build Toolchain Linux Platform| Swift Build Toolchain Linux Platform
218+
To test the minimal freestanding stdlib on macho, you can use the support for running a miscellanous preset against a snapshot toolchain.
219+
220+
```
221+
preset=stdlib_S_standalone_minimal_macho_x86_64,build,test
222+
@swift-ci please test with toolchain and preset
223+
```
188224

189225
### Testing Compiler Performance
190226

0 commit comments

Comments
 (0)