Add documentation for Global AnalyzerConfig #20824
Conversation
Global AnalyzerConfig is a new configuration file format for providing project level analyzer options. It works orthogonally with EditorConfig, which provides file/directory based options. See dotnet/roslyn#47707 for more detailed description. This PR primarily adds documentation from the same issue. Additionally, it also adds documentation for precedence between options (severity options and non-severity options) coming from different configuration sources. This addresses dotnet/roslyn#47154.
There was a problem hiding this comment.
Ah the complexities of code analysis :)
In configuration-options, there are still one or two mentions of "editorconfig" - can you update those?
Also, we should link from the existing precedence section to the interfile precedence section. E.g. "For information about how inter-file precedence is decided, see ". And then backlink to this section from the new precedence section.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
@gewarren I think I addressed all your feedback |
Did you add the precedence section links? I didn't see them but maybe I missed something. [Also, we should link from the existing precedence section to the interfile precedence section. E.g. "For information about how inter-file precedence is decided, see ". And then backlink to this section from the new precedence section.] |
Ah, I added a link one way. Let me add the back link too. |
|
@gewarren Hopefully one last review... |
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
@gewarren good to merge? |
Summary
Global AnalyzerConfig is a new configuration file format for providing project level analyzer options. It works orthogonally with EditorConfig, which provides file/directory based options. See dotnet/roslyn#47707 for more detailed description. This PR primarily adds documentation from the same issue.
Additionally, it also adds documentation for precedence between options (severity options and non-severity options) coming from different configuration sources. This addresses dotnet/roslyn#47154.
[Edited by gewarren to add preview link.]