Skip to content

Commit c90e443

Browse files
committed
Update readme describing how generate-swiftsyntax with HEAD works
1 parent 087569d commit c90e443

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CodeGeneration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains file to generate source code that is part of the SwiftSy
44

55
Some source code inside SwiftSyntax is generated using [SwiftSyntaxBuilder](../Sources/SwiftSyntaxBuilder), a Swift library whose purpose is to generate Swift code using Swift itself. This kind of code generation is performed by the Swift package defined in this directory.
66

7-
This directory is a standalone package that uses a pinned version of SwiftSyntaxBuilder. It is thus NOT using SwiftSyntaxBuilder of the parent directory. This guarantees that when `generate-swiftsyntax` is run, it can't break its own build.
7+
This directory is a standalone package that uses HEAD of the current branch. This guarantees that when `generate-swiftsyntax` is run, it can't break its own build when run multiple times without committing. This also mean that comitting changes could break `generate-swiftsyntax`.
88

99
To re-generate the files after changing `CodeGeneration` run the `generate-swiftsyntax`
1010
target of `CodeGeneration` and pass `path/to/swift-syntax/Sources` as the argument.

0 commit comments

Comments
 (0)