diff options
| author | João Távora | 2023-03-17 22:33:46 +0000 |
|---|---|---|
| committer | João Távora | 2023-03-18 12:22:47 +0000 |
| commit | 013057e3512be3c224df5ee228b479b950ae9fa5 (patch) | |
| tree | 9634b408a344d2e61bc68e6851be454185e00424 /doc/misc | |
| parent | 94a21c88647e5142696f3ec731f17c7e94ee64e5 (diff) | |
| download | emacs-013057e3512be3c224df5ee228b479b950ae9fa5.tar.gz emacs-013057e3512be3c224df5ee228b479b950ae9fa5.zip | |
; Prefer "language server" to "LSP server" in Eglot manual
* eglot.texi (Quick Start, Customizing Eglot)
(Project-specific configuration)
(Troubleshooting Eglot): LSP server -> language server.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/eglot.texi | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi index 5ebc055ecf7..034297b0e68 100644 --- a/doc/misc/eglot.texi +++ b/doc/misc/eglot.texi | |||
| @@ -154,11 +154,11 @@ Use Eglot. | |||
| 154 | 154 | ||
| 155 | Most Eglot facilities are integrated into Emacs features, such as | 155 | Most Eglot facilities are integrated into Emacs features, such as |
| 156 | ElDoc, Flymake, Xref, and Imenu. However, Eglot also provides | 156 | ElDoc, Flymake, Xref, and Imenu. However, Eglot also provides |
| 157 | commands of its own, mainly to perform tasks by the LSP server, such | 157 | commands of its own, mainly to perform tasks by the language server, |
| 158 | as @kbd{M-x eglot-rename} (to rename an identifier across the entire | 158 | such as @kbd{M-x eglot-rename} (to rename an identifier across the |
| 159 | project), @kbd{M-x eglot-format} (to reformat and reindent code), and | 159 | entire project), @kbd{M-x eglot-format} (to reformat and reindent |
| 160 | some others. @xref{Eglot Commands}, for the detailed list of Eglot | 160 | code), and some others. @xref{Eglot Commands}, for the detailed list |
| 161 | commands. | 161 | of Eglot commands. |
| 162 | 162 | ||
| 163 | @item | 163 | @item |
| 164 | That's it! | 164 | That's it! |
| @@ -968,7 +968,7 @@ mechanism. | |||
| 968 | @cindex progress | 968 | @cindex progress |
| 969 | @item eglot-report-progress | 969 | @item eglot-report-progress |
| 970 | Set this variable to true if you'd like progress notifications coming | 970 | Set this variable to true if you'd like progress notifications coming |
| 971 | from the LSP server to be handled as Emacs's progress reporting | 971 | from the language server to be handled as Emacs's progress reporting |
| 972 | facilities. | 972 | facilities. |
| 973 | @end table | 973 | @end table |
| 974 | 974 | ||
| @@ -1079,10 +1079,11 @@ plists. Some examples are useful. | |||
| 1079 | 1079 | ||
| 1080 | Let's say you want to configure two language servers to be used in a | 1080 | Let's say you want to configure two language servers to be used in a |
| 1081 | project written in a combination of the Python and Go languages. You | 1081 | project written in a combination of the Python and Go languages. You |
| 1082 | want to use the @command{pylsp} and @command{gopls} LSP servers. In | 1082 | want to use the @command{pylsp} and @command{gopls} languages |
| 1083 | the documentation of the servers in question (or in some other editor's | 1083 | servers. In the documentation of the servers in question (or in some |
| 1084 | configuration file, or in some blog article), you find the following | 1084 | other editor's configuration file, or in some blog article), you find |
| 1085 | configuration options in informal dotted-notation syntax: | 1085 | the following configuration options in informal dotted-notation |
| 1086 | syntax: | ||
| 1086 | 1087 | ||
| 1087 | @example | 1088 | @example |
| 1088 | pylsp.plugins.jedi_completion.include_params: true | 1089 | pylsp.plugins.jedi_completion.include_params: true |
| @@ -1300,13 +1301,14 @@ slowly, try to customize the variable @code{eglot-events-buffer-size} | |||
| 1300 | (@pxref{Eglot Variables}) to 0. This will disable any debug logging | 1301 | (@pxref{Eglot Variables}) to 0. This will disable any debug logging |
| 1301 | and may speed things up. | 1302 | and may speed things up. |
| 1302 | 1303 | ||
| 1303 | In other situations, the cause of poor performance lies in the LSP | 1304 | In other situations, the cause of poor performance lies in the |
| 1304 | server itself. Servers use aggressive caching and other techniques to | 1305 | language server itself. Servers use aggressive caching and other |
| 1305 | improve their performance. Often, this can be tweaked by changing the | 1306 | techniques to improve their performance. Often, this can be tweaked |
| 1306 | server configuration (@pxref{Advanced server configuration}). | 1307 | by changing the server configuration (@pxref{Advanced server |
| 1308 | configuration}). | ||
| 1307 | 1309 | ||
| 1308 | If you think you have found a bug, we want to hear about it. Before | 1310 | If you think you have found a bug, we want to hear about it. Before |
| 1309 | reporting a bug, keep in mind that interaction with LSP servers | 1311 | reporting a bug, keep in mind that interaction with language servers |
| 1310 | represents a large quantity of unknown variables. Therefore, it is | 1312 | represents a large quantity of unknown variables. Therefore, it is |
| 1311 | generally both @emph{difficult} and @emph{absolutely essential} that | 1313 | generally both @emph{difficult} and @emph{absolutely essential} that |
| 1312 | the maintainers reproduce bugs exactly as they happened to you, the | 1314 | the maintainers reproduce bugs exactly as they happened to you, the |