update and unify the "please file a bug report" message #34376
Conversation
|
@swift-ci smoke test |
| "please file a radar or open a bug on bugs.swift.org with this code, and " | ||
| "add -Xfrontend -validate-tbd-against-ir=none to squash the errors", ()) | ||
| SWIFT_BUG_REPORT_MESSAGE | ||
| "Add -Xfrontend -validate-tbd-against-ir=none to squash the errors", ()) |
There was a problem hiding this comment.
Nit: "add" should not be capitalized. You may also want to single-quote the flags.
include/swift/Basic/Compiler.h
Outdated
| "Please submit a bug report (https://swift.org/contributing/#reporting-bugs)" \ | ||
| " and include the crash backtrace." |
There was a problem hiding this comment.
Nit: in diagnostics, the capitalization and period are improper. I'm not sure if it needs to be different for the LLVM crash string; if it does, you might need two constants that vary only in capitalization.
I also think that, for most (possibly all) of these diagnostics, we should ask users to include their project along with the crash report. Most compiler bugs are trivial to reproduce with the source code and very hard to reproduce without it. We'll get much higher quality bug reports if we ask up-front for the project.
If we're centralizing this message, it might be good to ask whether we should make the URL overridable with -D during compilation. For instance, I could imagine Apple Swift compilers saying "<swift.org URL> or use Feedback Assistant", or SwiftWasm pointing people to their GitHub Issues page.
eeckstein
force-pushed
the
bug-report-message
branch
from
1ea84c6 to
b4cc5a8
Compare
The new message is: "Please submit a bug report (https://swift.org/contributing/#reporting-bugs) and include the crash backtrace." 1. In crash logs we used to print a message which points to the llvm bug tracking page. Now it points to the swift.org bug tracking guidelines. 2. Use the same message in all compiler diagnostics which ask the user to file a bug report. rdar://problem/70488534
eeckstein
force-pushed
the
bug-report-message
branch
from
b4cc5a8 to
1224cfa
Compare
|
@brentdax I pushed a new version |
|
@swift-ci smoke test |
The new message is:
"Please submit a bug report (https://swift.org/contributing/#reporting-bugs) and include the crash backtrace."
rdar://problem/70488534