Skip to content

[CXX Safe Buffer] Update the documentation for unsafe_buffer_usage attribute #135087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2025
Merged

[CXX Safe Buffer] Update the documentation for unsafe_buffer_usage attribute #135087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions clang/include/clang/Basic/AttrDocs.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down