[clang] [CXX Safe Buffer] Update the documentation for unsafe_buffer_usage attribute (PR #135087)
Malavika Samak via cfe-commits
cfe-commits at lists.llvm.org
Wed Apr 9 15:12:17 PDT 2025
https://github.com/malavikasamak updated https://github.com/llvm/llvm-project/pull/135087
>From edbdfa66b45be76014f003f8e2d6f2d2871ea253 Mon Sep 17 00:00:00 2001
From: MalavikaSamak <malavika2 at apple.com>
Date: Wed, 9 Apr 2025 14:31:06 -0700
Subject: [PATCH] Update the documentation for the unsafe_buffer_usage
attribute to capture the new beahvior introduced by
https://github.com/llvm/llvm-project/pull/125671
---
clang/include/clang/Basic/AttrDocs.td | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index c8b371280e35d..97a5f24d35d7d 100644
--- a/clang/include/clang/Basic/AttrDocs.td
+++ b/clang/include/clang/Basic/AttrDocs.td
@@ -7517,9 +7517,11 @@ the field it is attached to, and it may also lead to emission of automatic fix-i
hints which would help the user replace the use of unsafe functions(/fields) with safe
alternatives, though the attribute can be used even when the fix can't be automated.
-* Attribute attached to functions: The attribute does not suppress
- ``-Wunsafe-buffer-usage`` inside the function to which it is attached.
- These warnings still need to be addressed.
+* Attribute attached to functions: The attribute suppresses all
+ ``-Wunsafe-buffer-usage`` warnings within the function it is attached to, as the
+ function is now classified as unsafe. The attribute should be used carefully, as it
+ will silence all unsafe operation warnings inside the function; including any new
+ unsafe operations introduced in the future.
The attribute is warranted even if the only way a function can overflow
the buffer is by violating the function's preconditions. For example, it
More information about the cfe-commits
mailing list