Skip to content

Commit eed56be

Browse files
authored
Merge pull request #1563 from ahoppen/ahoppen/clarify-swift-version
Explicitly specify how many last versions of Swift we want to support
2 parents e6da60a + 0881289 commit eed56be

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Alternatively you can also build it from the command line using `build-script.py
1414
- (enclosing directory)
1515
- swift-argument-parser
1616
- swift-syntax
17+
```
1718
2. Execute the following command
1819
```bash
1920
swift-syntax/build-script.py build --toolchain /Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-<recent date>.xctoolchain/usr
@@ -62,15 +63,15 @@ Tip: Running SwiftSyntax’s self-parse tests takes the majority of testing time
6263
2. Select the Arguments tab in the Run section
6364
3. Add a `SKIP_LONG_TESTS` environment variable with value `1`
6465

65-
### `lit`-based tests
66+
### `lit`-based Tests
6667

6768
A few tests are based LLVM’s `lit` and `FileCheck` tools.
6869
To run these, build `FileCheck`, e.g. by building the Swift compiler and run the tests using the following command:
6970
```bash
7071
./build-script.py test --toolchain /Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-<recent date>.xctoolchain/usr --skip-lit-tests --filecheck-exec /path/to/build/Release+Asserts/llvm-macosx-x86_64/bin/FileCheck
7172
```
7273

73-
## Generating source code
74+
## Generating Source Code
7475

7576
If you want to modify the code-generated files, perform the following steps:
7677

@@ -86,3 +87,7 @@ If you want to modify the code-generated files, perform the following steps:
8687
swift-syntax/build-script.py generate-source-code --toolchain /Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-<recent date>.xctoolchain/usr
8788
```
8889
3. The new source-generated file will be written into your `Sources` directory.
90+
91+
## Swift Version
92+
93+
We require that SwiftSyntax builds with the latest released compiler and the previous major version (e.g. with Swift 5.8 and Swift 5.7).

0 commit comments

Comments
 (0)