[PATCH] D118519: [clang-tidy] Organize the release notes a little better

Richard via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sat Jan 29 19:17:51 PST 2022


LegalizeAdulthood marked an inline comment as done.
LegalizeAdulthood added inline comments.


================
Comment at: clang-tools-extra/docs/ReleaseNotes.rst:221-227
 Removed checks
 ^^^^^^^^^^^^^^
 
 Improvements to include-fixer
 -----------------------------
 
 The improvements are...
----------------
salman-javed-nz wrote:
> 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?
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.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D118519/new/

https://reviews.llvm.org/D118519



More information about the cfe-commits mailing list