This is an archive of the discontinued LLVM Phabricator instance.

[clang-tidy] Organize the release notes a little better
ClosedPublic

Authored by LegalizeAdulthood on Jan 28 2022, 5:18 PM.

Details

Summary
  • Sort new checks by check name
  • Sort changes to existing checks by check name
  • Link check names to the check's documentation
  • Add docs for changes to readability-simplify-boolean-expr
  • Move check changes from "Improvements to clang-tidy" to "Changes in existing checks" section

Diff Detail

Event Timeline

LegalizeAdulthood requested review of this revision.Jan 28 2022, 5:18 PM
This revision is now accepted and ready to land.Jan 29 2022, 5:30 AM
salman-javed-nz added inline comments.
clang-tools-extra/docs/ReleaseNotes.rst
223–229

Small nit, not about this patch, but the documentation release process as a whole.

Clang 13 got released with a lot of these placeholders still in the documentation.
https://releases.llvm.org/13.0.0/tools/clang/tools/extra/docs/ReleaseNotes.html
They were never tidied up before release.

What could be done to ensure that this doesn't happen again? Perhaps keep the placeholders in the file but in a commented-out state?

I'm aware of https://llvm.org/docs/HowToReleaseLLVM.html#update-documentation but in this case I guess it wasn't enough to capture this?

LegalizeAdulthood marked an inline comment as done.Jan 29 2022, 7:17 PM
LegalizeAdulthood added inline comments.
clang-tools-extra/docs/ReleaseNotes.rst
223–229

I think it would be reasonable to have them as comment blocks.

I don't know if there's an automated process for generating/updating
release notes.

This revision was automatically updated to reflect the committed changes.
LegalizeAdulthood marked an inline comment as done.
njames93 added inline comments.Jan 30 2022, 12:46 AM
clang-tools-extra/docs/ReleaseNotes.rst
223–229

I was always under the impression those got removed when the release branch is created