branch: externals/matlab-mode
commit 04e22322f3bd21c608d6a1d9e255c4842eaafb86
Author: John Ciolfi <[email protected]>
Commit: John Ciolfi <[email protected]>
README.org: move lsp content ino doc/matlab-language-server-lsp-mode.org
---
README.org | 24 +++++-------------------
doc/matlab-language-server-lsp-mode.org | 18 +++++++++++++++---
2 files changed, 20 insertions(+), 22 deletions(-)
diff --git a/README.org b/README.org
index bff86eff89..782c7bcb6e 100644
--- a/README.org
+++ b/README.org
@@ -14,25 +14,11 @@
2. *Code navigation and more*
- - The [[https://github.com/mathworks/MATLAB-language-server][MATLAB
Language Server]], matlabls, for code navigation, code completion, go to
definition,
- find references, and more. matlabls is a separate special MATLAB process
that Emacs
- communicates with. For example, when you ask Emacs to jump to the
definition of a function via
- =M-.= or =M-x xref-find-definitions=, Emacs will ask the matlabls process
where the function is
- located and use it's response to jump to the definition.
-
- #+begin_example
- +-----------+ +------------+
- | | | |
- | Emacs |<==========>| matlabls |
- | | | |
- +-----------+ +------------+
- #+end_example
-
- You need to install and setup the MATLAB Language Server to use it.
- See
[[file:doc/matlab-language-server-lsp-mode.org][doc/matlab-language-server-lsp-mode.org]].
-
- - Imenu support for quickly jumping to function declarations in the current
~*.m~ file.
- See [[file:doc/matlab-imenu.org][doc/matlab-imenu.org]].
+ - The [[file:doc/matlab-language-server-lsp-mode.org][MATLAB Language
Server with Emacs]], matlabls, provides code navigation, code completion, go
+ to definition, find references, and more.
+
+ - Imenu support for quickly jumping to function declarations in the current
~*.m~ or ~*.tlc~
+ file. See [[file:doc/matlab-imenu.org][doc/matlab-imenu.org]].
3. *M-x matlab-shell* for running and debugging MATLAB within Emacs (Unix
only).
diff --git a/doc/matlab-language-server-lsp-mode.org
b/doc/matlab-language-server-lsp-mode.org
index a3fc29f15d..5a174bd5ba 100644
--- a/doc/matlab-language-server-lsp-mode.org
+++ b/doc/matlab-language-server-lsp-mode.org
@@ -29,7 +29,20 @@
The [[https://github.com/mathworks/MATLAB-language-server][MATLAB Language
Server]], matlabls, is used for code navigation, code completion,
go to definition, find references, and more. To use matlabls, see
[[Installation][installation]] below.
-It also works with Emacs on Windows as show below.
+matlabls also works with [[Windows Emacs with LSP][Emacs on Windows]].
+
+matlabls is a separate special MATLAB process that Emacs communicates with.
For example, when you
+ask Emacs to jump to the definition of a function via =M-.= or =M-x
xref-find-definitions=, Emacs
+will ask the matlabls process where the function is located and use it's
response to jump to the
+definition.
+
+#+begin_example
+ +-----------+ +------------+
+ | | | |
+ | Emacs |<==========>| matlabls |
+ | | | |
+ +-----------+ +------------+
+#+end_example
* Code Navigation - Jump to Definition and Back
@@ -92,7 +105,7 @@ type =M-,= to jump back.
#+end_src
In Emacs:
-
+
: M-: (require 'lsp-matlab)
: M-x customize-variable RET lsp-clients-matlab-server RET
@@ -138,4 +151,3 @@ The examples below were created on Windows 11 using Emacs
30.1. The setup I use
PATH before the gpg from MSYS2.
4. Install the Emacs packages listed above.
5. Install the MATLAB Lanugage Server as shown above.
-
