Skip to content

Add DiagnosticDescriptorHelper to set HelpURI for generator / analyzer diagnostics#90353

Merged
ericstj merged 3 commits into
dotnet:mainfrom
ericstj:DiagnosticDescriptorHelper
Aug 12, 2023
Merged

Add DiagnosticDescriptorHelper to set HelpURI for generator / analyzer diagnostics#90353
ericstj merged 3 commits into
dotnet:mainfrom
ericstj:DiagnosticDescriptorHelper

Conversation

@ericstj

@ericstj ericstj commented Aug 10, 2023

Copy link
Copy Markdown
Member

Fixes #85181

Create a helper method that formats and sets the helpLink for DiagnosticDescriptors

See https://github.com/search?q=repo%3Adotnet%2Fruntime+%28%22new+DiagnosticDescriptor%28%22+OR+%22new+DiagnosticDescriptor+%28%22%29&type=code

Absent are those from

return new DiagnosticDescriptor (diagnosticId.AsString (),

I wasn't sure if those are published at the same URL. Maybe those are all here: https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trim-warnings/il2001 ? If so - perhaps we can just modify that existing helper class. Thoughts @mateoatr @vitek-karas?

Create a helper method that formats and sets the helpLink for
DiagnosticDescriptors
@ghost

ghost commented Aug 10, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #85181

Create a helper method that formats and sets the helpLink for DiagnosticDescriptors

See https://github.com/search?q=repo%3Adotnet%2Fruntime+%28%22new+DiagnosticDescriptor%28%22+OR+%22new+DiagnosticDescriptor+%28%22%29&type=code

Absent are those from

return new DiagnosticDescriptor (diagnosticId.AsString (),

I wasn't sure if those are published at the same URL. Maybe those are all here: https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trim-warnings ? If so - perhaps we can just modify that existing helper class. Thoughts @mateoatr @vitek-karas?

Author: ericstj
Assignees: -
Labels:

area-Meta

Milestone: -

@ericstj ericstj requested a review from sbomer as a code owner August 11, 2023 15:59
@ericstj

ericstj commented Aug 11, 2023

Copy link
Copy Markdown
Member Author

If so - perhaps we can just modify that existing helper class. Thoughts @mateoatr @vitek-karas?

I took another look this morning and found that we could fix this. Please review @dotnet/illink

@sbomer

sbomer commented Aug 11, 2023

Copy link
Copy Markdown
Member

Nice, thanks! Did you forget to commit GetHelpUri?

@ericstj ericstj force-pushed the DiagnosticDescriptorHelper branch from 2bd195d to 8f0a9bb Compare August 11, 2023 16:40
@ericstj ericstj requested a review from marek-safar as a code owner August 11, 2023 16:40
Comment thread src/tools/illink/src/ILLink.Shared/DiagnosticId.cs Outdated

@sbomer sbomer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you, LGTM!

@ericstj

ericstj commented Aug 12, 2023

Copy link
Copy Markdown
Member Author

Linker test failures are #90431

@ericstj ericstj merged commit 7325cc4 into dotnet:main Aug 12, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Sep 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

F1 on our source generator errors goes nowhere because we don't set a HelpUri

3 participants