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

via cfe-commits cfe-commits at lists.llvm.org
Tue Sep 10 19:29:43 PDT 2024


https://github.com/MichelleCDjunaidi updated https://github.com/llvm/llvm-project/pull/107956

>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 1/2] 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.

>From 2362387592bd01efaa394d871cf2368fe02a4093 Mon Sep 17 00:00:00 2001
From: MichelleCDjunaidi <michellechrisalyn at gmail.com>
Date: Wed, 11 Sep 2024 10:28:48 +0800
Subject: [PATCH 2/2] Fix wording and wrap column to 80 characters

---
 .../docs/clang-tidy/Contributing.rst          | 26 ++++++++++---------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index bbbd945853c146..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. 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 :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.
+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 differ slightly). You can use local variables to preserve 
+your intention-revealing names that you applied to nested matchers.
 
 Creating private matchers
 ^^^^^^^^^^^^^^^^^^^^^^^^^



More information about the cfe-commits mailing list