Commit Graph

4 Commits

Author SHA1 Message Date
Doug Gregor
5b5a3e3d07 Point at diagnostic group documentation on docs.swift.org 2025-04-14 20:08:24 -07:00
Doug Gregor
e88f8995e1 [Diagnostics] Eliminate educational notes in favor of diagnostic groups
We've been converging the implementations of educational notes and
diagnostic groups, where both provide category information in
diagnostics (e.g., `[#StrictMemorySafety]`) and corresponding
short-form documentation files. The diagnostic group model is more
useful in a few ways:

* It provides warnings-as-errors control for warnings in the group
* It is easier to associate a diagnostic with a group with
GROUPED_ERROR/GROUPED_WARNING than it is to have a separate diagnostic
ID -> mapping.
* It is easier to see our progress on diagnostic-group coverage
* It provides an easy name to use for diagnostic purposes.

Collapse the educational-notes infrastructure into diagnostic groups,
migrating all of the existing educational notes into new groups.
Simplify the code paths that dealt with multiple educational notes to
have a single, possibly-missing "category documentation URL", which is
how we're treating this.
2025-03-29 15:40:35 -07:00
Doug Gregor
db2fa7bcda [Diagnostics] Use the educational note name for the category name 2025-03-04 09:14:48 -08:00
Pavel Yaskevich
a549048c90 [Diagnostics] Add educational notes into serialized diagnostics
Use flag record (currently unused) to emit semi-colon separated
list of paths to educational notes associated with a diagnostic.

Resolves: rdar://118993780
2023-12-12 12:59:48 -08:00