Skip to content

Commit

Permalink
add a note about CLANG_TIDY_IGNORE_SOURCES to docs (#2789)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric T. Johnson <[email protected]>
  • Loading branch information
zingale and yut23 authored Mar 19, 2024
1 parent bfce27d commit c7f497f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions Docs/source/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -121,5 +127,3 @@ to operate over.

Physics issues
==============


0 comments on commit c7f497f

Please sign in to comment.