This is an archive of the discontinued LLVM Phabricator instance.

Updates documentation to include command to run clang-tidy tests.
ClosedPublic

Authored by lethalantidote on Feb 8 2017, 4:12 PM.

Reviewers

Commits

Summary

Adds the commandline need to run clang-tidy tests.

dlj accepted this revision.Feb 9 2017, 5:16 PM

This revision is now accepted and ready to land.Feb 9 2017, 5:16 PM

LGTM. I will land shortly.

This revision was automatically updated to reflect the committed changes.

Path

Size

clang-tools-extra/

trunk/

docs/

clang-tidy/

6 lines

	Show First 20 Lines • Show All 531 Lines • ▼ Show 20 Lines
	.. code-block:: console			.. code-block:: console

	$ clang-tidy -config="{CheckOptions: [{key: a, value: b}, {key: x, value: y}]}" ...			$ clang-tidy -config="{CheckOptions: [{key: a, value: b}, {key: x, value: y}]}" ...


	Testing Checks			Testing Checks
	--------------			--------------

				To run tests for :program:`clang-tidy` use the command:

				.. code-block:: console

				$ ninja check-clang-tools

	:program:`clang-tidy` checks can be tested using either unit tests or			:program:`clang-tidy` checks can be tested using either unit tests or
	`lit`_ tests. Unit tests may be more convenient to test complex replacements			`lit`_ tests. Unit tests may be more convenient to test complex replacements
	with strict checks. `Lit`_ tests allow using partial text matching and regular			with strict checks. `Lit`_ tests allow using partial text matching and regular
	expressions which makes them more suitable for writing compact tests for			expressions which makes them more suitable for writing compact tests for
	diagnostic messages.			diagnostic messages.

	The ``check_clang_tidy.py`` script provides an easy way to test both			The ``check_clang_tidy.py`` script provides an easy way to test both
	diagnostic messages and fix-its. It filters out ``CHECK`` lines from the test			diagnostic messages and fix-its. It filters out ``CHECK`` lines from the test
	▲ Show 20 Lines • Show All 93 Lines • Show Last 20 Lines