Skip to content

[swift-snapshot-tool] Two small improvements to the README.md #83335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions utils/swift_snapshot_tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ value is at. This allows for one to get a sense of the range of time in between
two bisect numbers since one can look at the range in between them and how time
varies.

One can specify a branch of snapshots to list. By default uses
--development. Also supports the options --release_5_0, --release_6_0,
--release_6_2.

## Run

```
Expand Down Expand Up @@ -56,7 +60,8 @@ Options:
an error was fixed.

- branch: This controls the specific branch of snapshots that are downloaded. By
default uses development. Also supports the options 5.0 and 6.0.
default uses --development. Also supports the options --release_5_0,
--release_6_0, --release_6_2.

## Bisect

Expand Down Expand Up @@ -94,4 +99,17 @@ Options:
an error was fixed.

- branch: This controls the specific branch of snapshots that are downloaded. By
default uses development. Also supports the options 5.0 and 6.0.
default uses --development. Also supports the options --release_5_0,
--release_6_0, --release_6_2.

# FAQ and Helpful Tips

## Bisecting against examples using Swift Testing

Swift Testing is not stored in the normal place in a toolchain. To test against
such an example that uses swift testing pass into ones script the following -I
command:

```
xcrun ${SWIFTC} "${@:1}" -o binary -parse-as-library -I ${SWIFT_LIBRARY_PATH}/testing
```