From c7f497f011da4dade5cb4d6eb0d8f359d0712521 Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Tue, 19 Mar 2024 15:01:45 -0400 Subject: [PATCH] add a note about CLANG_TIDY_IGNORE_SOURCES to docs (#2789) Co-authored-by: Eric T. Johnson --- Docs/source/debugging.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Docs/source/debugging.rst b/Docs/source/debugging.rst index 4baf52c717..3341984d51 100644 --- a/Docs/source/debugging.rst +++ b/Docs/source/debugging.rst @@ -85,6 +85,12 @@ 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 and headers. This is set by + the parameter ``CLANG_TIDY_IGNORE_SOURCES`` in ``Make.Castro``, and + the ``HeaderFilterRegex`` whitelist in ``.clang-tidy``. Thread sanitizer @@ -121,5 +127,3 @@ to operate over. Physics issues ============== - -