Do a large edit of the Clang release notes.
This is meant to be merged into the Clang 16.x branch.
Differential D142578
[Clang][Doc] Edit the Clang release notes ClosedPublic Authored by royjacobson on Jan 25 2023, 1:06 PM.
Details
Summary Do a large edit of the Clang release notes. This is meant to be merged into the Clang 16.x branch.
Diff Detail
Unit TestsFailed Event TimelineComment Actions A handful of suggestions as I spot-checked. This looks great, thank you for doing this! I'd like Aaron to take a look though.
Comment Actions
Comment Actions Thanks Erich and Emilia! The html file is attached here, I think it's probably easier to proof read that way. (Took me a bit to figure out the CMake magic...) ReleaseNotes.html110 KBDownload Comment Actions I think it's worthwhile to mark comments with the "Done" checkmark in Phrabricator if they have been addressed
Comment Actions I am not the only one who has a different background. If the introduction says this is the introduction of the release notes, I am not super motivated to read on. I would prefer to see some highlights to motivate the readers to continue reading. Comment Actions
You've mentioned what I think are separate issues - that this document is difficult to read for readers from different backgrounds and that the introduction might be too long or unengaging. I mostly agree about the first point - I've tried to do what I could to make it more accessible but I don't think it's enough. About the second point - I'm not really sure what to change. I think the 'potentially breaking changes' section is more important than the 'what's new' section, but the 'what's new' section IS the second section (and there's a table of contents). Are there specific topics you think we should remove from the introduction or move into the intro from the 'what's new' section? I'd like to avoid duplicating information if we can. Comment Actions IDK. Clang 16 is fully is a fully conformant C++20 except for some DRs. Or beginning with Clang 16, we start a long-term project to overhaul the diagnostics. I agree that breaking changes are important. Comment Actions
I contemplated on this for a bit, and I don't have anything that I feel is representative enough and fits into one paragraph. I'm still not against the general idea though. Comment Actions Thank you for working on this, it is really shaping up nicely!
I think "major announcements" should be limited to things almost everyone will want to know about, like "we're changing our license" or "we've finished support for <major language revision>". So not every release will have major announcements, and that's fine -- we can remove any empty sections from the release notes.
royjacobson marked 2 inline comments as done. Comment Actions15 -> Clang 15
This revision is now accepted and ready to land.Feb 13 2023, 5:18 AM R2RT mentioned this in D147414: [python] Expose clang_Location_isInSystemHeader.Apr 2 2023, 10:00 AM
Revision Contents
Diff 493008 clang/docs/ReleaseNotes.rst
|
Are you planning to merge the changes in generic text over to the trunk once this lands?