Skip to content
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.

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

[clang][NFC] Add missing space in -Wunsafe-buffer-usage documentation #107905

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

ldionne
Copy link
Member

@ldionne ldionne commented Sep 9, 2024

That missing space was causing the whole sentence to be rendered incorrectly in the resulting HTML.

That missing space was causing the whole sentence to be rendered
incorrectly in the resulting HTML.
@llvmbot llvmbot added clang Clang issues not falling into any other category clang:frontend Language frontend issues, e.g. anything involving "Sema" labels Sep 9, 2024
@ldionne ldionne changed the title [clang][NFC] Add missing space in documentation [clang][NFC] Add missing space in -Wunsafe-buffer-usage documentation Sep 9, 2024
@llvmbot
Copy link
Collaborator

llvmbot commented Sep 9, 2024

@llvm/pr-subscribers-clang

Author: Louis Dionne (ldionne)

Changes

That missing space was causing the whole sentence to be rendered incorrectly in the resulting HTML.


Full diff: https://github.com/llvm/llvm-project/pull/107905.diff

1 Files Affected:

  • (modified) clang/include/clang/Basic/AttrDocs.td (+1-1)
diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index 546e5100b79dd9..cc9bc499c9cc24 100644
--- a/clang/include/clang/Basic/AttrDocs.td
+++ b/clang/include/clang/Basic/AttrDocs.td
@@ -6849,7 +6849,7 @@ def UnsafeBufferUsageDocs : Documentation {
 The attribute ``[[clang::unsafe_buffer_usage]]`` should be placed on functions
 that need to be avoided as they are prone to buffer overflows or unsafe buffer
 struct fields. It is designed to work together with the off-by-default compiler
-warning ``-Wunsafe-buffer-usage``to help codebases transition away from raw pointer
+warning ``-Wunsafe-buffer-usage`` to help codebases transition away from raw pointer
 based buffer management, in favor of safer abstractions such as C++20 ``std::span``.
 The attribute causes ``-Wunsafe-buffer-usage`` to warn on every use of the function or
 the field it is attached to, and it may also lead to emission of automatic fix-it

@ldionne
Copy link
Member Author

ldionne commented Sep 16, 2024

I don't think this is very controversial so I'll land now that the CI has run.

@ldionne ldionne merged commit 83bb731 into llvm:main Sep 16, 2024
12 checks passed
@ldionne ldionne deleted the review/clang-nfc-whitespace-in-doc branch September 16, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang:frontend Language frontend issues, e.g. anything involving "Sema" clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants