Skip to content

Commit 8f6eb73

Browse files
committed
Update readme describing how generate-swiftsyntax with HEAD works
1 parent 222563f commit 8f6eb73

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CodeGeneration/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ 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.
8+
This means that `CodeGeneration` will build against your latest local commit of SwiftSyntax. If you are making changes to `SwiftSyntax` that affect how code is being generated, commit your SwiftSyntax changes (pushing is not necessary) and re-generate files afterwards.
89

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

0 commit comments

Comments
 (0)