[PATCH] D28189: Extend documentation of how to test clang-tidy checks.

Alexander Kornienko via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sat Dec 31 01:33:25 PST 2016

alexfh accepted this revision.
alexfh added a comment.
This revision is now accepted and ready to land.

Awesome! Thank you for adding clarity to this part.

Looks good with a couple of nits.

Comment at: docs/clang-tidy/index.rst:550
+separate `FileCheck`_ invocations: once with FileCheck's directive
+prefix set to `CHECK-MESSAGES`, validating the diagnostic messages,
+and once with the directive prefix set to `CHECK-FIXES`, running
Inline code snippets in rst should use double backquotes. I know, that's confusing, but it's what we have to deal with.

Comment at: docs/clang-tidy/index.rst:555
+that code was not modified by fixits, by checking that it is present
+unchanged in the fixed code.  The full set of `FileCheck` directives
+is available (e.g., `CHECK-MESSAGES-SAME:`, `CHECK-MESSAGES-NOT:`), though
Put an underscore after `FileCheck` (as in line 549). This is a syntax for a named reference. See also http://llvm.org/docs/SphinxQuickstartTemplate.html


More information about the cfe-commits mailing list