dotnet / dotnet/linker

We should document actionable steps for some warning codes

Open
#1,965 3 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
C#
Stars
392
Forks
128
Avg merge
2d 10h
Merged PRs (30d)
2

Description

There are some warning codes that explain to you why an issue happens, but then they leave you with no actionable item. Am I able to suppress it in a certain scenario? Is it always dangerous?
Maybe we should have documented certain common scenarios, if a warning gives false positives 50% of the time, how to recognize them and suppress them. For example, IL2060 sounds like a very dangerous pattern since it cannot be analyzed statically by the linker, but they are certain scenarios that make it trim safe without user action and can be suppressed. Is it something that we can document?
Another case is when we know a pattern will always be unsafe, we could link the warning to documentation on how to use descriptor files/dynamic dependency.
Is this something we can include in the error-codes.md?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.