[CXX Safe Buffer] Update the documentation for unsafe_buffer_usage attribute #135087
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
llvmbot
added
clang
|
@llvm/pr-subscribers-clang Author: Malavika Samak (malavikasamak) ChangesUpdate the documentation for the unsafe_buffer_usage attribute to capture the new behavior introduced by #125671 Full diff: https://github.com/llvm/llvm-project/pull/135087.diff 1 Files Affected:
diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index c8b371280e35d..1546d849f6856 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 the
+ ``-Wunsafe-buffer-usage`` warnings inside the function to which it is attached, since
+ it is now classified as an unsafe function. The attribute must be placed judiciously
+ as there won't be any warning for unsafe operations within the function and this can
+ also cause it to mask new usafe 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
|
malavikasamak
changed the title
…ture the new beahvior introduced by llvm#125671
malavikasamak
force-pushed
the
msamak-update-sb-documentation
branch
from
c3fbfd7 to
edbdfa6
Compare
var-const
pushed a commit
to ldionne/llvm-project
that referenced
this pull request
Apr 17, 2025
…tribute (llvm#135087) Update the documentation for the unsafe_buffer_usage attribute to capture the new behavior introduced by llvm#125671 Co-authored-by: MalavikaSamak <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the documentation for the unsafe_buffer_usage attribute to capture the new behavior introduced by #125671