AaronBallman wrote: > > CC @tstellar @tru for help answering this but I think it might be this > > file? > > https://github.com/llvm/llvm-project/blob/main/clang/docs/ReleaseNotesTemplate.txt > > I think the changes here are a bit... awkward. These release notes are > > meant to be read by users and downstreams as much as by other developers, > > even while under active development. So the text is kind of out of place > > for those folks. Also, my experience has been that folks tend not to read > > the existing text in the file anyway, so they're just as likely to miss > > this new text as they are to miss the headings (particularly as the release > > notes get longer and so that text may be scrolled off screen for them). > > Noted. Tweaked it slightly. Let me know how you feel about it now. > > > Another approach to solve this problem would be to remove the subcategories > > under the static analyzer heading so it's just a general list of changes to > > the static analyzer. Or to spread the static analyzer changes out among the > > other categories. WDYT about a reorganization of some kind instead of > > adding text like that? > > I prefer having a CSA section, because users already expect that section. > Usual clang users don't really care about CSA anyway, so this goes both ways.
Still not super keen on it because there are other subsections that could use the same labeling (New Features and Improvements are also just as confusing as Crash and Bug Fixes). FWIW, what I was suggesting with removing the subcategories is: ``` diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst index c9d21558c94f..d36ed8eaf9d8 100644 --- a/clang/docs/ReleaseNotes.rst +++ b/clang/docs/ReleaseNotes.rst @@ -214,18 +214,6 @@ Code Completion Static Analyzer --------------- -New features -^^^^^^^^^^^^ - -Crash and bug fixes -^^^^^^^^^^^^^^^^^^^ - -Improvements -^^^^^^^^^^^^ - -Moved checkers -^^^^^^^^^^^^^^ - .. _release-notes-sanitizers: Sanitizers ``` So the heading would still be there for the static analyzer as before, but we remove the subcategories causing confusion. I don't know if that was clear before or not. https://github.com/llvm/llvm-project/pull/175935 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
