================
@@ -0,0 +1,63 @@
+====================================
+Query Based Custom Clang-Tidy Checks
+====================================
+
+Introduction
+============
+
+This page provides examples of how to add query based custom checks for
+:program:`clang-tidy`.
+
+Custom checks are based on :program:`clang-query` syntax. Every custom checks
+will be registered in `custom` module to avoid name conflict. They can be
+enabled or disabled by the checks option like the built-in checks.
+
+Custom checks support inheritance from parent configurations like other
+configuration items.
+
+Goal: easy to write, cross platform, multiple versions supported toolkit for
+custom clang-tidy rules.
+Non-Goal: complex checks, performance, fix-its, etc.
+
+Configuration
+=============
+
+`CustomChecks` is a list of custom checks. Each check must contain
+  - Name: check name can been used in `-checks` option.
+  - Query: query string
----------------
vbvictor wrote:

```suggestion
  - Query: :program:`clang-query` string
```
or
```suggestion
  - Query: `clang-query` string
```

https://github.com/llvm/llvm-project/pull/131804
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to