[Serialized diagnostics] Emit category documentation URL #80228
Merged
+22
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Emit the category documentation URL into serialized diagnostics as part of the existing RECORD_CATEGORY, using the form <category name>@<category URL> and keeping the existing "category name length" field referring to the length of the category name itself (up to the @). There is a corresponding update to libclang to process such category names correctly and add API, but it isn't strictly necessary: readers that use the category name length field correctly will see no behavior change, whereas readers that ignore it will merely see the extra `@<category URL>`. This is a step toward staging out our (mis)use of the "flags" field as the place to stash educational note and diagnostic group documentation URLs.
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
|
@swift-ci please smoke test Windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Emit the category documentation URL into serialized diagnostics as part of the existing RECORD_CATEGORY, using the form
@
and keeping the existing "category name length" field referring to the length of the category name itself (up to the @). There is a corresponding update to libclang to process such category names correctly and add API, but it isn't strictly necessary: readers that use the category name length field correctly will see no behavior change, whereas readers that ignore it will merely see the extra
@<category URL>.This is a step toward staging out our (mis)use of the "flags" field as the place to stash educational note and diagnostic group documentation URLs.