[Mlir-commits] [mlir] fcecfcb - [mlir-lsp-server][Docs] Tweak the documentation for the visual studio code extension

[River Riddle]

Author: River Riddle
Date: 2021-06-16T17:58:53-07:00
New Revision: fcecfcb92c77b470d45885db5ef077f9c3166bc3

URL: https://github.com/llvm/llvm-project/commit/fcecfcb92c77b470d45885db5ef077f9c3166bc3
DIFF: https://github.com/llvm/llvm-project/commit/fcecfcb92c77b470d45885db5ef077f9c3166bc3.diff

LOG: [mlir-lsp-server][Docs] Tweak the documentation for the visual studio code extension

This revision updates the feature set, and cleans up the contributing section a little.

Added: 
    

Modified: 
    mlir/docs/Tools/MLIRLSP.md

Removed: 
    


################################################################################
diff  --git a/mlir/docs/Tools/MLIRLSP.md b/mlir/docs/Tools/MLIRLSP.md
index 0b7f79ed30ecc..5627cae22e6ef 100644
--- a/mlir/docs/Tools/MLIRLSP.md
+++ b/mlir/docs/Tools/MLIRLSP.md
@@ -147,28 +147,30 @@ may vary. Below are a set of plugins that are known to work:
 
 ### Visual Studio Code
 
-Provides MLIR language IDE features for VS code.
+Provides MLIR language IDE features for VS code:
+
+*   Syntax highlighting for .mlir files and `mlir` markdown blocks
+*   go-to-definition and cross references
+*   Detailed information when hovering over IR entities
+*   Outline and navigation of symbols and symbol tables
+*   Live parser and verifier diagnostics
 
 #### Setup
 
-This extension requires the `mlir-lsp-server` language server. If not found in
-your path, you must specify the path of the server in the settings of this
-extension.
+This extension requires the
+[`mlir-lsp-server` language server](https://mlir.llvm.org/docs/Tools/MLIRLSP/).
+If not found in your path, you must specify the path of the server in the
+settings of this extension.
 
-#### Developing in the LLVM monorepo
+#### Contributing
 
-This extension is actively developed within the LLVM monorepo, at
-`mlir/utils/vscode`. When developing or deploying this extension within the LLVM
-monorepo, a few extra steps for setup are required:
+This extension is actively developed within the
+[LLVM monorepo](https://github.com/llvm/llvm-project/tree/main/mlir/utils/vscode),
+at `mlir/utils/vscode`. When developing or deploying this extension within the
+LLVM monorepo, a few extra setup steps are required:
 
 *   Copy `mlir/utils/textmate/mlir.json` to the extension directory and rename
     to `grammar.json`.
 
-#### Features
-
-*   Syntax highlighting for .mlir files and `mlir` markdown blocks
-*   go-to-definition and cross references
-    *   Definitions include the source file locations of operations in the .mlir
-*   Hover over IR entities to see more information about them
-    *   e.g. for a Block, you can see its block number as well as any
-        predecessors or successors.
+Please follow the existing code style when contributing to the extension, we
+recommend to run `npm run format` before sending a patch.