Author: MichelleCDjunaidi Date: 2024-09-11T08:32:01-04:00 New Revision: 80fcab8c26129a98f01ce4f8d9cc90f3653bf693
URL: https://github.com/llvm/llvm-project/commit/80fcab8c26129a98f01ce4f8d9cc90f3653bf693 DIFF: https://github.com/llvm/llvm-project/commit/80fcab8c26129a98f01ce4f8d9cc90f3653bf693.diff LOG: [Docs][clang-query] disclose Windows linetab bug on clang-query tab auto-complete (#107956) As per https://github.com/llvm/llvm-project/pull/106672/#issuecomment-2325577815 and https://github.com/llvm/llvm-project/issues/107377, the documentation should be updated to note that the current bug on Windows involving ``LineEditor`` causing Tab key related features to not work. Fixes #107377 Added: Modified: clang-tools-extra/docs/clang-tidy/Contributing.rst Removed: ################################################################################ diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst index d5303418b859b2..ff8b05ff263c14 100644 --- a/clang-tools-extra/docs/clang-tidy/Contributing.rst +++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst @@ -344,18 +344,20 @@ matching expressions to simplify your matcher. clang-query> let c1 cxxRecordDecl() clang-query> match c1 -Alternatively, pressing the tab key after a previous matcher's open parentheses would also -show which matchers can be chained with the previous matcher, though some matchers that work -may not be listed. - -Just like breaking up a huge function into smaller chunks with intention-revealing names -can help you understand a complex algorithm, breaking up a matcher into smaller matchers -with intention-revealing names can help you understand a complicated matcher. - -Once you have a working clang-query matcher, the C++ API matchers will be the same or similar -to your interactively constructed matcher (there can be cases where they diff er slightly). -You can use local variables to preserve your intention-revealing names that you applied -to nested matchers. +Alternatively, pressing the tab key after a previous matcher's open parentheses +would also show which matchers can be chained with the previous matcher, +though some matchers that work may not be listed. Note that tab completion +does not currently work on Windows. + +Just like breaking up a huge function into smaller chunks with +intention-revealing names can help you understand a complex algorithm, breaking +up a matcher into smaller matchers with intention-revealing names can help +you understand a complicated matcher. + +Once you have a working :program:`clang-query` matcher, the C++ API matchers +will be the same or similar to your interactively constructed matcher (there +can be cases where they diff er slightly). You can use local variables to preserve +your intention-revealing names that you applied to nested matchers. Creating private matchers ^^^^^^^^^^^^^^^^^^^^^^^^^ _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
