Skip to content
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.

Sign up for GitHub

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

Added a link to the issue we're using to track data race safety reporting inconsistencies to the builds FAQ #3565

Merged
merged 3 commits into from
Dec 24, 2024
Merged

Added a link to the issue we're using to track data race safety reporting inconsistencies to the builds FAQ #3565

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a03419
Tweaked the wording of one of the data race safety FAQ points.
daveverwer Dec 24, 2024
77b41bc
Added a note about false negatives to the data race safety FAQ.
daveverwer Dec 24, 2024
625c107
Typos in copy.
daveverwer Dec 24, 2024
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
4 changes: 3 additions & 1 deletion Resources/Markdown/docs/builds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ You can [find more details in this issue](https://github.com/SwiftPackageIndex/S

The Swift 6.0 compiler can check whether code is safe from data races at compile time with “complete” concurrency checks enabled. The data race safety information we publish on package pages comes from diagnostics output by the compiler as we build each package.

It’s not possible for us to distinguish between a package that genuinely has no data race safety errors and one where the errors are being suppressed. All we can report on is the number of data race errors reported by the compiler.
It’s not possible to distinguish between a package that genuinely has no data race safety errors and one where the errors are being suppressed in code. The number we display on the page is the number of data race errors that the compiler reports.

Note that this does not affect package compatibility, as shown in the compatibility matrix. A package can be fully compatible with Swift 6.x without enabling strict concurrency checks, provided it is not running in Swift 6 language mode. For more information on opting into Swift 6 language mode, [read the Swift 6 migration guide for more information](https://www.swift.org/migration/documentation/swift-6-concurrency-migration-guide/completechecking).

**Note:** If you see inconsistencies between the number of data race safety errors reported by the Swift Package Index and the number you see in local testing, we are [tracking a potential issue with false negatives reported by the Swift compiler](https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/3233#issuecomment-2560966121). Please feel free to note packages that may be affected in that issue thread.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kinda wonder if I false positives is the better term here. It depends on which way you're looking at it but I suppose most people would think of the "positive case" as the one where there are errors. When I named the issue I was thinking in terms of positive/negative results and flipped the meaning essentially.

Loading