Author: tmroeder Date: Tue Jul 30 09:49:28 2019 New Revision: 367333 URL: http://llvm.org/viewvc/llvm-project?rev=367333&view=rev Log: [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 Modified: clang-tools-extra/trunk/docs/ReleaseNotes.rst clang-tools-extra/trunk/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst Modified: clang-tools-extra/trunk/docs/ReleaseNotes.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/ReleaseNotes.rst?rev=367333&r1=367332&r2=367333&view=diff ============================================================================== --- clang-tools-extra/trunk/docs/ReleaseNotes.rst (original) +++ clang-tools-extra/trunk/docs/ReleaseNotes.rst Tue Jul 30 09:49:28 2019 @@ -71,15 +71,7 @@ Improvements to clang-tidy <clang-tidy/checks/linuxkernel-must-use-errs>` 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 <clang-tidy/checks/google-upgrade-googletest-case>` check. Modified: clang-tools-extra/trunk/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst?rev=367333&r1=367332&r2=367333&view=diff ============================================================================== --- clang-tools-extra/trunk/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst (original) +++ clang-tools-extra/trunk/docs/clang-tidy/checks/linuxkernel-must-use-errs.rst Tue Jul 30 09:49:28 2019 @@ -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. +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 also checks for unused values returned by functions that return -``ERR_PTR``. +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: _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
