about summary refs log tree commit diff
path: root/docs/dev
diff options
context:
space:
mode:
authorveetaha <veetaha2@gmail.com>2020-04-02 11:23:56 +0300
committerveetaha <veetaha2@gmail.com>2020-04-02 11:23:56 +0300
commitdd5e4d4870b4e59bc82d285c481bb6971d016912 (patch)
tree672f5ebda7447c06ff28556515e41b13cef261e1 /docs/dev
parent036a8aee2af960428218cecd68ea2ea1813ab7f6 (diff)
downloadrust-dd5e4d4870b4e59bc82d285c481bb6971d016912.tar.gz
rust-dd5e4d4870b4e59bc82d285c481bb6971d016912.zip
vscode: move docks about syntax tree to dev/README.md
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 8d7e1801092..f230dc1db1a 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -155,6 +155,16 @@ There's also two VS Code commands which might be of interest:
 
 * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection.
 
+  You can hover over syntax nodes in the opened text file to see the appropriate
+  rust code that it refers to and the rust editor will also highlight the proper
+  text range.
+
+  If you press <kbd>Ctrl</kbd> (i.e. trigger goto definition) in the inspected
+  Rust source file the syntax tree read-only editor should scroll to and select the
+  appropriate syntax node token.
+
+  ![demo](https://user-images.githubusercontent.com/36276403/78225773-6636a480-74d3-11ea-9d9f-1c9d42da03b0.png)
+
 # Profiling
 
 We have a built-in hierarchical profiler, you can enable it by using `RA_PROFILE` env-var: