This is an archive of the discontinued LLVM Phabricator instance.

[mlir][mlir-lsp-server] Add some initial documentation on the MLIR LSP server
ClosedPublic

Authored by rriddle on Apr 16 2021, 3:01 PM.

Details

Summary

This covers some of the basic documentation, but is still missing some documentation/examples of features provided by the server. Feature documentation will be added in a followup.

Depends On D100607

Diff Detail

Event Timeline

rriddle created this revision.Apr 16 2021, 3:01 PM
rriddle requested review of this revision.Apr 16 2021, 3:01 PM
mehdi_amini accepted this revision.Apr 16 2021, 4:44 PM

Thanks for the high-level doc!

mlir/docs/Tools/MLIRLSP.md
93

This should start with 4 #### in order to nest I think.
(below as well?)

110

How does it interact with https://marketplace.visualstudio.com/items?itemName=MomenAbdelkarim-WyattCalandro-LuisPrieto.mlir ? Should we tell people to disable it? (I don't know if the extension has metadata to warn about it?)

This revision is now accepted and ready to land.Apr 16 2021, 4:44 PM
rriddle updated this revision to Diff 339368.Apr 21 2021, 1:27 PM
rriddle marked 2 inline comments as done.

update

rriddle added inline comments.Apr 21 2021, 1:28 PM
mlir/docs/Tools/MLIRLSP.md
110

I know we can warn about specific extensions within our extension (like how clangd does), but I need to see if we could also check for conflicting language extensions in general. Let me do some research and I'll prepare a followup for this.