Skip to content

Commit

Permalink
Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
  • Loading branch information
kscottz and clalancette authored Dec 19, 2024
1 parent b29cab8 commit 3ea362c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ If you happen to find an issue with one of your files you can address it by call

The ``ament_cppcheck`` command line tool can be used to perform static analysis of C++ source code files.
`Static analysis <https://en.wikipedia.org/wiki/Static_program_analysis>`_ is the process of automatically reviewing source code files for patterns that can often cause issues after compilation.
Some versions of cpp_check, the underlying utility used by ``ament_cppcheck``, can be rather slow.
Some versions of `cppcheck <https://github.com/danmar/cppcheck>`__, the underlying utility used by ``ament_cppcheck``, can be rather slow.
For this reason ``ament_cppcheck`` may be disabled on some systems.
To enable it, you simply need to set the ``AMENT_CPPCHECK_ALLOW_SLOW_VERSIONS`` environment variable.

Expand Down

0 comments on commit 3ea362c

Please sign in to comment.