Skip to content

[Diagnostics] Serialized diagnostics for diagnostic groups #79694

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 3 commits into from
Feb 28, 2025

Conversation

DougGregor
Copy link
Member

Start supporting serialized diagnostics for diagnostic groups, including:

  • Set the "category" field in serialized diagnostics to the diagnostic group name
  • Put the path to the diagnostic group documentation file into the "flag" field (extending the existing hack)
  • Move diagnostic group documentation into the same place as educational notes

The serialized diagnostic format has some extra fields that we can
adopt for diagnostic groups. Specifically:
* Category: store the diagnostic group name here
* Flags: extend the hack used by educational notes of placing Markdown file paths here
Since these different forms of documentation have a similar purpose,
and there's already some infrastructure for educational notes, unify all of
the diagnostics-related documentation in a single place.

We might consider unifying these ideas in the compiler as well, but
that's for another day.
@DougGregor
Copy link
Member Author

@swift-ci please smoke test

@DougGregor DougGregor enabled auto-merge February 28, 2025 15:10
@DougGregor DougGregor merged commit 7f8de34 into swiftlang:main Feb 28, 2025
3 checks passed
@DougGregor DougGregor deleted the diagnostic-group-serialized branch February 28, 2025 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant