From: Tom Roeder Date: Tue, 30 Jul 2019 16:49:28 +0000 (+0000) Subject: [clang-tidy] Fix the documentation for linuxkernel-must-use-errs. X-Git-Tag: llvmorg-11-init~13277 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=61493df7c6548aa6552248b74fd1de4d34d1459a;p=platform%2Fupstream%2Fllvm.git [clang-tidy] Fix the documentation for linuxkernel-must-use-errs. Summary: This changes ReleaseNotes.txt to have the first sentence of the full documentation from linuxkernel-must-use-errs.rst. This addresses a comment from the review of rL367071 in https://reviews.llvm.org/D59963. Reviewers: Eugene.Zelenko Subscribers: xazax.hun, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D65343 llvm-svn: 367333 --- diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 38875ed..2514480 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -71,15 +71,7 @@ Improvements to clang-tidy ` check. Checks Linux kernel code to see if it uses the results from the functions in - ``linux/err.h``. Also checks to see if code uses the results from functions that - directly return a value from one of these error functions. - - 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 - values must be checked, since positive pointers and negative error codes are - being used in the same context. These functions are marked with - ``__attribute__((warn_unused_result))``, but some kernel versions do not have - this warning enabled for clang. + ``linux/err.h``. - New :doc:`google-upgrade-googletest-case ` check. diff --git a/clang-tools-extra/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst b/clang-tools-extra/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst index f7d8a3b..8a85426 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst @@ -3,14 +3,16 @@ linuxkernel-must-use-errs ========================= -Checks for cases where the kernel error functions ``ERR_PTR``, -``PTR_ERR``, ``IS_ERR``, ``IS_ERR_OR_NULL``, ``ERR_CAST``, and -``PTR_ERR_OR_ZERO`` are called but the results are not used. These -functions are marked with ``__attribute__((warn_unused_result))``, but -the compiler warning for this attribute is not always enabled. - -This also checks for unused values returned by functions that return -``ERR_PTR``. +Checks Linux kernel code to see if it uses the results from the functions in +``linux/err.h``. Also checks to see if code uses the results from functions that +directly return a value from one of these error functions. + +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 +values must be checked, since positive pointers and negative error codes are +being used in the same context. These functions are marked with +``__attribute__((warn_unused_result))``, but some kernel versions do not have +this warning enabled for clang. Examples: