[PATCH] D59963: [clang-tidy] Add a module for the Linux kernel.

Tom Roeder via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Jul 26 10:04:02 PDT 2019


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


================
Comment at: clang-tools-extra/docs/ReleaseNotes.rst:77
+
+  This is important in the Linux kernel because ``ERR_PTR``, ``PTR_ERR``,
+  ``IS_ERR``, ``IS_ERR_OR_NULL``, ``ERR_CAST``, and ``PTR_ERR_OR_ZERO`` return
----------------
Eugene.Zelenko wrote:
> tmroeder wrote:
> > Eugene.Zelenko wrote:
> > > Release Notes should include short description. One sentence is enough, but it'll good idea to keep it same as first statement of documentation.
> > Would you like me to submit a patch that removes the second paragraph of this description, then?
> Yes. Documentation is created for details. But you still need to make its first sentence same as in Release Notes. See other checks and their Release Notes as example (in previous release branches).
I'm sorry, I don't understand. What's the referent of "it" in "you still need to make its first sentence same as in Release Notes"? What first sentence needs to match the first sentence of the Release Notes?

If it's the header file documentation (MustCheckErrs.h), then as far as I can tell, the first paragraph of Release Notes is identical to the first paragraph of the .h file documentation, other than the double backquotes, which I didn't think belonged in a .h file comment.

What am I missing?


Repository:
  rL LLVM

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

https://reviews.llvm.org/D59963





More information about the cfe-commits mailing list