[lldb] Add a blurb about not including private headers

JDevlieghere · JDevlieghere · commit f130351aff7b · 2025-10-07T17:10:32.000-07:00
Add a blurb about not including private headers and be explicit about
TestingSupport as it's a bit of a footgun.
diff --git 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)

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@ add_lldb_unittest(APITests`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`# Build with -Wdocumentation. This relies on the tests including all the API`
`11`		`-# headers through API/LLDB.h.`
	`11`	`+# headers through API/LLDB.h. It also means that the API tests cannot include`
	`12`	`+# private headers, including anything from from TestingSupport.`
`12`	`13`	`check_cxx_compiler_flag("-Wdocumentation"`
`13`	`14`	`CXX_SUPPORTS_DOCUMENTATION)`
`14`	`15`	`if (CXX_SUPPORTS_DOCUMENTATION)`