Differential D27815 Diff 81596 docs/clang-tidy/index.rst

Changeset View

Standalone View

docs/clang-tidy/index.rst

	Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Lines
	``cppcoreguidelines-`` Checks related to C++ Core Guidelines.			``cppcoreguidelines-`` Checks related to C++ Core Guidelines.
	``clang-analyzer-`` Clang Static Analyzer checks.			``clang-analyzer-`` Clang Static Analyzer checks.
	``google-`` Checks related to the Google coding conventions.			``google-`` Checks related to the Google coding conventions.
	``llvm-`` Checks related to the LLVM coding conventions.			``llvm-`` Checks related to the LLVM coding conventions.
	``misc-`` Checks that we didn't have a better category for.			``misc-`` Checks that we didn't have a better category for.
	``modernize-`` Checks that advocate usage of modern (currently "modern"			``modernize-`` Checks that advocate usage of modern (currently "modern"
	means "C++11") language constructs.			means "C++11") language constructs.
	``mpi-`` Checks related to MPI (Message Passing Interface).			``mpi-`` Checks related to MPI (Message Passing Interface).
				``obvious-`` Checks for obvious bugs that probably won't be found
				in working code, but can be found while looking for an
				obvious bug in broken code.
	``performance-`` Checks that target performance-related issues.			``performance-`` Checks that target performance-related issues.
	``readability-`` Checks that target readability-related issues that don't			``readability-`` Checks that target readability-related issues that don't
	relate to any particular coding style.			relate to any particular coding style.
	====================== =========================================================			====================== =========================================================

	Clang diagnostics are treated in a similar way as check diagnostics. Clang			Clang diagnostics are treated in a similar way as check diagnostics. Clang
	diagnostics are displayed by :program:`clang-tidy` and can be filtered out using			diagnostics are displayed by :program:`clang-tidy` and can be filtered out using
	``-checks=`` option. However, the ``-checks=`` option does not affect			``-checks=`` option. However, the ``-checks=`` option does not affect
	▲ Show 20 Lines • Show All 546 Lines • Show Last 20 Lines