[lldb] Add a blurb about not including private headers #162404
Merged
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
|
@llvm/pr-subscribers-lldb Author: Jonas Devlieghere (JDevlieghere) ChangesAdd a blurb about not including private headers and be explicit about TestingSupport as it's a bit of a footgun. Full diff: https://github.com/llvm/llvm-project/pull/162404.diff 1 Files Affected:
diff --git a/lldb/unittests/API/CMakeLists.txt b/lldb/unittests/API/CMakeLists.txt
index 06ac49244176c..5748964720458 100644
--- a/lldb/unittests/API/CMakeLists.txt
+++ b/lldb/unittests/API/CMakeLists.txt
@@ -8,7 +8,8 @@ add_lldb_unittest(APITests
)
# Build with -Wdocumentation. This relies on the tests including all the API
-# headers through API/LLDB.h.
+# headers through API/LLDB.h. It also means that the API tests cannot include
+# private headers, including anything from from TestingSupport.
check_cxx_compiler_flag("-Wdocumentation"
CXX_SUPPORTS_DOCUMENTATION)
if (CXX_SUPPORTS_DOCUMENTATION)
|
jimingham
reviewed
Oct 8, 2025
Add a blurb about not including private headers.
JDevlieghere
force-pushed
the
private-headers-in-api-tests
branch
from
f130351 to
18dbd0c
Compare
bulbazord
approved these changes
Oct 8, 2025
JDevlieghere
added a commit
to swiftlang/llvm-project
that referenced
this pull request
Oct 9, 2025
Add a blurb about not including private headers in the API tests. (cherry picked from commit 9527f93)
svkeerthy
pushed a commit
that referenced
this pull request
Oct 9, 2025
Add a blurb about not including private headers in the API tests.
clingfei
pushed a commit
to clingfei/llvm-project
that referenced
this pull request
Oct 10, 2025
Add a blurb about not including private headers in the API tests.
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.
Add a blurb about not including private headers in the API tests.