mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-27 17:16:06 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
This revision updates the feature set, and cleans up the contributing section a little.
This commit is contained in:
River Riddle 2021-06-16 17:58:24 -07:00
parent a6e8ed7776
commit fcecfcb92c
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
mlir/docs/Tools/MLIRLSP.md
View File

@ -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.