Skip to content

Commit 2a3e0f1

Browse files
committed
doc
1 parent 9c1828f commit 2a3e0f1

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

clang-tools-extra/docs/clang-tidy/QueryBasedCustomChecks.rst

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,6 @@ Configuration
3535
Example
3636
=======
3737

38-
Note: Since this feature is currently in the development stage. The API may
39-
change in the future. It needs to be explicitly enabled by
40-
`--experimental-custom-checks`.
41-
42-
We also welcome suggestions in the link https://discourse.llvm.org/t/support-query-based-clang-tidy-external-check/85331.
43-
4438
.. code-block:: yaml
4539
4640
Checks: -*,custom-call-main-function
@@ -67,3 +61,22 @@ We also welcome suggestions in the link https://discourse.llvm.org/t/support-que
6761
void bar() {
6862
main(); // warning: call to main function. [custom-call-main-function]
6963
}
64+
65+
Matters Need Attention
66+
======================
67+
68+
This feature needs to be explicitly enabled by `--experimental-custom-checks`
69+
because it is currently in the experimental stage. Welcome to submit any
70+
suggestions in the `link <https://discourse.llvm.org/t/support-query-based-clang-tidy-external-check/85331>`_.
71+
72+
During the experimental stage, the required configuration structure of this
73+
feature may be changed in the future. Future changes will be as
74+
forward-compatible as possible, but this is not a guarantee.
75+
76+
In subsequent versions, including non-experimental stage, the query statements
77+
will change at any time. The essence of :program:`clang-query` is to parse the
78+
query string and dynamically generate the corresponding AST matcher.
79+
Therefore, its functionality is entirely dependent on the functions provided by
80+
the AST matcher library.
81+
The ast matcher will change along with the changes in the clang AST.
82+
Please refer to `ast matcher reference <https://clang.llvm.org/docs/LibASTMatchersReference.html>`_.

0 commit comments

Comments
 (0)