[clang-tools-extra] disclose Windows linetab bug on clang-query tab auto-complete (PR #107956)

via cfe-commits cfe-commits at lists.llvm.org
Mon Sep 9 20:20:08 PDT 2024


https://github.com/MichelleCDjunaidi created https://github.com/llvm/llvm-project/pull/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.

>From f7e11ba4d19320397d653a17f769f87260db8b86 Mon Sep 17 00:00:00 2001
From: MichelleCDjunaidi <87893361+MichelleCDjunaidi at users.noreply.github.com>
Date: Tue, 10 Sep 2024 11:15:24 +0800
Subject: [PATCH] disclose Windows linetab bug on clang-query tab auto-complete

---
 clang-tools-extra/docs/clang-tidy/Contributing.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index d5303418b859b2..bbbd945853c146 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -346,13 +346,13 @@ matching expressions to simplify your matcher.
 
 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.
+may not be listed. Note that this suggestion feature currently does not 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 clang-query matcher, the C++ API matchers will be the same or similar 
+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 differ slightly). 
 You can use local variables to preserve your intention-revealing names that you applied 
 to nested matchers.



More information about the cfe-commits mailing list