diff options
| author | Eli Zaretskii | 2022-10-20 19:02:14 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2022-10-20 19:02:14 +0300 |
| commit | 5c99112e8940d8d4ffef393a3fd05d553b43861b (patch) | |
| tree | 7befb58c7421078ada386bdf24e38cd21ddd4d53 | |
| parent | c44ea4548da12ad5d43cacbc1f26831bb8c1f7fe (diff) | |
| download | emacs-5c99112e8940d8d4ffef393a3fd05d553b43861b.tar.gz emacs-5c99112e8940d8d4ffef393a3fd05d553b43861b.zip | |
; Minor copyedits to eglot.texi.
| -rw-r--r-- | doc/misc/eglot.texi | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi index e5c38a6e3d6..033464f9909 100644 --- a/doc/misc/eglot.texi +++ b/doc/misc/eglot.texi | |||
| @@ -62,14 +62,20 @@ modify this GNU manual.'' | |||
| 62 | @cindex language server protocol | 62 | @cindex language server protocol |
| 63 | Eglot is the Emacs client for the @dfn{Language Server Protocol} | 63 | Eglot is the Emacs client for the @dfn{Language Server Protocol} |
| 64 | (@acronym{LSP}). The name ``Eglot'' is an acronym that stands for | 64 | (@acronym{LSP}). The name ``Eglot'' is an acronym that stands for |
| 65 | ``@emph{E}macs Poly@emph{glot}''.@footnote{ | 65 | @ifhtml |
| 66 | ``@emph{E}macs Poly@emph{glot}''. | ||
| 67 | @end ifhtml | ||
| 68 | @ifnothtml | ||
| 69 | ``Emacs polyGLOT''. | ||
| 70 | @end ifnothtml | ||
| 71 | @footnote{ | ||
| 66 | A @dfn{polyglot} is a | 72 | A @dfn{polyglot} is a |
| 67 | person who is able to use several languages. | 73 | person who is able to use several languages. |
| 68 | } Eglot provides infrastructure and a set of commands for enriching | 74 | } Eglot provides infrastructure and a set of commands for enriching |
| 69 | the source code editing capabilities of Emacs via LSP. LSP is a | 75 | the source code editing capabilities of Emacs via LSP. LSP is a |
| 70 | standardized communications protocol between source code editors (such | 76 | standardized communications protocol between source code editors (such |
| 71 | as Emacs) and language servers, programs external to Emacs for | 77 | as Emacs) and language servers---programs external to Emacs which |
| 72 | analyzing source code on behalf of Emacs. The protocol allows Emacs | 78 | analyze the source code on behalf of Emacs. The protocol allows Emacs |
| 73 | to receive various source code services from the server, such as | 79 | to receive various source code services from the server, such as |
| 74 | description and location of functions calls, types of variables, class | 80 | description and location of functions calls, types of variables, class |
| 75 | definitions, syntactic errors, etc. This way, Emacs doesn't need to | 81 | definitions, syntactic errors, etc. This way, Emacs doesn't need to |
| @@ -417,9 +423,10 @@ activated automatically as you type. | |||
| 417 | 423 | ||
| 418 | @item | 424 | @item |
| 419 | If a completion package such as @code{company-mode}, a popular | 425 | If a completion package such as @code{company-mode}, a popular |
| 420 | third-party completion package, is installed, Eglot enhances it by | 426 | third-party completion package (or any other completion package), is |
| 421 | providing completion candidates based on the language-server analysis | 427 | installed, Eglot enhances it by providing completion candidates based |
| 422 | of the source code. (@code{company-mode} can be installed from GNU ELPA.) | 428 | on the language-server analysis of the source code. |
| 429 | (@code{company-mode} can be installed from GNU ELPA.) | ||
| 423 | 430 | ||
| 424 | @item | 431 | @item |
| 425 | If @code{yasnippet}, a popular third-party package for automatic | 432 | If @code{yasnippet}, a popular third-party package for automatic |
| @@ -432,8 +439,9 @@ completion package to instantiate these snippets using | |||
| 432 | If the popular third-party package @code{markdown-mode} is installed, | 439 | If the popular third-party package @code{markdown-mode} is installed, |
| 433 | and the server provides at-point documentation formatted as Markdown | 440 | and the server provides at-point documentation formatted as Markdown |
| 434 | in addition to plain text, Eglot arranges for the ElDoc package to | 441 | in addition to plain text, Eglot arranges for the ElDoc package to |
| 435 | enrich this text with e.g. fontification before displaying it to the | 442 | enrich this text with fontifications and other nice formatting before |
| 436 | user. | 443 | displaying it to the user. This makes the documentation shown by |
| 444 | ElDoc look nicer on display. | ||
| 437 | 445 | ||
| 438 | @item | 446 | @item |
| 439 | In addition to enabling and enhancing other features and packages, | 447 | In addition to enabling and enhancing other features and packages, |
| @@ -777,7 +785,9 @@ unexpectedly. The default value 3 means to attempt reconnection only | |||
| 777 | if the previous successful connection lasted for more than that number | 785 | if the previous successful connection lasted for more than that number |
| 778 | of seconds; a different positive value changes the minimal length of | 786 | of seconds; a different positive value changes the minimal length of |
| 779 | the connection to trigger reconnection. A value of @code{t} means | 787 | the connection to trigger reconnection. A value of @code{t} means |
| 780 | always reconnect automatically, and @code{nil} means never reconnect. | 788 | always reconnect automatically, and @code{nil} means never reconnect |
| 789 | (in which case you will need to reconnect manually using @kbd{M-x | ||
| 790 | eglot}). | ||
| 781 | 791 | ||
| 782 | @item eglot-connect-timeout | 792 | @item eglot-connect-timeout |
| 783 | This specifies the number of seconds before connection attempt to a | 793 | This specifies the number of seconds before connection attempt to a |
| @@ -798,8 +808,7 @@ all during the waiting period. | |||
| 798 | This determines the size of the Eglot events buffer. @xref{Eglot | 808 | This determines the size of the Eglot events buffer. @xref{Eglot |
| 799 | Commands, eglot-events-buffer}, for how to display that buffer. If | 809 | Commands, eglot-events-buffer}, for how to display that buffer. If |
| 800 | the value is changed, for it to take effect the connection should be | 810 | the value is changed, for it to take effect the connection should be |
| 801 | restarted using @kbd{eglot-shutdown} followed by | 811 | restarted using @kbd{M-x eglot-reconnect}. |
| 802 | @kbd{eglot-reconnect}. | ||
| 803 | @c FIXME: Shouldn't the defcustom do this by itself using the :set | 812 | @c FIXME: Shouldn't the defcustom do this by itself using the :set |
| 804 | @c attribute? | 813 | @c attribute? |
| 805 | @xref{Troubleshooting Eglot}, for when this could be useful. | 814 | @xref{Troubleshooting Eglot}, for when this could be useful. |
| @@ -854,6 +863,7 @@ connections, are documented in @ref{Customizing Eglot}. | |||
| 854 | @chapter Customizing Eglot | 863 | @chapter Customizing Eglot |
| 855 | @cindex customizing Eglot | 864 | @cindex customizing Eglot |
| 856 | 865 | ||
| 866 | Eglot itself has a relatively small number of customization options. | ||
| 857 | A large part of customizing Eglot to your needs and preferences should | 867 | A large part of customizing Eglot to your needs and preferences should |
| 858 | actually be done via options of the Emacs packages and features which | 868 | actually be done via options of the Emacs packages and features which |
| 859 | Eglot supports and enhances (@pxref{Eglot Features}). For example: | 869 | Eglot supports and enhances (@pxref{Eglot Features}). For example: |