Skip to content

Commit 04e2232

Browse files
committed
README.org: move lsp content ino doc/matlab-language-server-lsp-mode.org
1 parent ccec389 commit 04e2232

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

README.org

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,11 @@
1414

1515
2. *Code navigation and more*
1616

17-
- The [[https://github.com/mathworks/MATLAB-language-server][MATLAB Language Server]], matlabls, for code navigation, code completion, go to definition,
18-
find references, and more. matlabls is a separate special MATLAB process that Emacs
19-
communicates with. For example, when you ask Emacs to jump to the definition of a function via
20-
=M-.= or =M-x xref-find-definitions=, Emacs will ask the matlabls process where the function is
21-
located and use it's response to jump to the definition.
22-
23-
#+begin_example
24-
+-----------+ +------------+
25-
| | | |
26-
| Emacs |<==========>| matlabls |
27-
| | | |
28-
+-----------+ +------------+
29-
#+end_example
30-
31-
You need to install and setup the MATLAB Language Server to use it.
32-
See [[file:doc/matlab-language-server-lsp-mode.org][doc/matlab-language-server-lsp-mode.org]].
33-
34-
- Imenu support for quickly jumping to function declarations in the current ~*.m~ file.
35-
See [[file:doc/matlab-imenu.org][doc/matlab-imenu.org]].
17+
- The [[file:doc/matlab-language-server-lsp-mode.org][MATLAB Language Server with Emacs]], matlabls, provides code navigation, code completion, go
18+
to definition, find references, and more.
19+
20+
- Imenu support for quickly jumping to function declarations in the current ~*.m~ or ~*.tlc~
21+
file. See [[file:doc/matlab-imenu.org][doc/matlab-imenu.org]].
3622

3723
3. *M-x matlab-shell* for running and debugging MATLAB within Emacs (Unix only).
3824

doc/matlab-language-server-lsp-mode.org

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,20 @@
2929

3030
The [[https://github.com/mathworks/MATLAB-language-server][MATLAB Language Server]], matlabls, is used for code navigation, code completion,
3131
go to definition, find references, and more. To use matlabls, see [[Installation][installation]] below.
32-
It also works with Emacs on Windows as show below.
32+
matlabls also works with [[Windows Emacs with LSP][Emacs on Windows]].
33+
34+
matlabls is a separate special MATLAB process that Emacs communicates with. For example, when you
35+
ask Emacs to jump to the definition of a function via =M-.= or =M-x xref-find-definitions=, Emacs
36+
will ask the matlabls process where the function is located and use it's response to jump to the
37+
definition.
38+
39+
#+begin_example
40+
+-----------+ +------------+
41+
| | | |
42+
| Emacs |<==========>| matlabls |
43+
| | | |
44+
+-----------+ +------------+
45+
#+end_example
3346

3447
* Code Navigation - Jump to Definition and Back
3548

@@ -92,7 +105,7 @@ type =M-,= to jump back.
92105
#+end_src
93106

94107
In Emacs:
95-
108+
96109
: M-: (require 'lsp-matlab)
97110
: M-x customize-variable RET lsp-clients-matlab-server RET
98111

@@ -138,4 +151,3 @@ The examples below were created on Windows 11 using Emacs 30.1. The setup I use
138151
PATH before the gpg from MSYS2.
139152
4. Install the Emacs packages listed above.
140153
5. Install the MATLAB Lanugage Server as shown above.
141-

0 commit comments

Comments
 (0)