add a note about CLANG_TIDY_IGNORE_SOURCES to docs

AMReX-Astro · Mar 19, 2024 · 0e8b17a · 0e8b17a
1 parent 1adfd51
commit 0e8b17a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/Docs/source/debugging.rst b/Docs/source/debugging.rst
@@ -85,6 +85,11 @@ You can also use ask it to fix errors automatically via:
 
 and you can treat warnings as errors by adding ``CLANG_TIDY_WARN_ERROR=TRUE``.
 
+.. note::
+
+ Building a Castro problem with ``clang-tidy`` will suppress the 
+ checks in AMReX and Microphysics sources. This is set by the parameter
+ ``CLANG_TIDY_IGNORE_SOURCES`` in ``Make.Castro``.
 
 
 Thread sanitizer