[Docs][clang-query] disclose Windows linetab bug on clang-query tab auto-complete

[MichelleCDjunaidi]

As per #106672 and #107377, the documentation should be updated to note that the current bug on Windows involving LineEditor causing Tab key related features to not work.

[llvmbot]

@llvm/pr-subscribers-clang-tidy

@llvm/pr-subscribers-clang-tools-extra

Author: None (MichelleCDjunaidi)

Changes

As per #106672 and #107377, the documentation should be updated to note that the current bug on Windows involving LineEditor causing Tab key related features to not work.

---

Full diff: https://github.com/llvm/llvm-project/pull/107956.diff

1 Files Affected:

• (modified) clang-tools-extra/docs/clang-tidy/Contributing.rst (+2-2)

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.

[github-actions]

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo.
Please turn off Keep my email addresses private setting in your account.
See LLVM Discourse for more information.

[AaronBallman]

Thank you for the improvements!

[AaronBallman]

LGTM!

[llvm-ci]

LLVM Buildbot has detected a new failure on builder clangd-ubuntu-tsan running on clangd-ubuntu-clang while building clang-tools-extra at step 2 "checkout".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/134/builds/5061

Here is the relevant piece of the build log for the reference

Step 2 (checkout) failure: update (failure)
git version 2.17.1
fatal: unable to access 'https://github.com/llvm/llvm-project.git/': Could not resolve host: github.com
fatal: unable to access 'https://github.com/llvm/llvm-project.git/': Could not resolve host: github.com