diff options
| author | João Távora | 2023-11-07 09:09:30 -0600 |
|---|---|---|
| committer | João Távora | 2023-11-07 09:09:44 -0600 |
| commit | 3ab99e977db01939cc42f285d5ce58807cf2e7d0 (patch) | |
| tree | 3f3e12f65d5dbc4be018d26a125a33563a4bd90a /doc/misc | |
| parent | 361f9fe4152f8dbb2a8c36c97bae13f689b606f0 (diff) | |
| download | emacs-3ab99e977db01939cc42f285d5ce58807cf2e7d0.tar.gz emacs-3ab99e977db01939cc42f285d5ce58807cf2e7d0.zip | |
Eglot: Demote errors to warnings in eglot-ensure
Github-reference: https://github.com/joaotavora/eglot/discussions/1318
* doc/misc/eglot.texi (Quick Start): Reword.
(Starting Eglot): Reword.
* lisp/progmodes/eglot.el (eglot-ensure): Demote errors to warnings.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/eglot.texi | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi index 9ffea80b641..2d9b2a2b60e 100644 --- a/doc/misc/eglot.texi +++ b/doc/misc/eglot.texi | |||
| @@ -139,16 +139,19 @@ To start using Eglot for a project, type @kbd{M-x eglot @key{RET}} in | |||
| 139 | a buffer visiting any file that belongs to the project. This starts | 139 | a buffer visiting any file that belongs to the project. This starts |
| 140 | the language server configured for the programming language of that | 140 | the language server configured for the programming language of that |
| 141 | buffer, and causes Eglot to start managing all the files of the | 141 | buffer, and causes Eglot to start managing all the files of the |
| 142 | project which use the same programming language. The notion of a | 142 | project which use the same programming language. This includes files |
| 143 | ``project'' used by Eglot is the same Emacs uses (@pxref{Projects,,, | 143 | of a given project that are already visited at the time the |
| 144 | emacs, GNU Emacs Manual}): in the simplest case, the ``project'' is | 144 | @code{eglot} command is invoked as well as files visited after this |
| 145 | the single file you are editing, but it can also be all the files in a | 145 | invocation. |
| 146 | single directory or a directory tree under some version control | ||
| 147 | system, such as Git. | ||
| 148 | 146 | ||
| 149 | Alternatively, you can start Eglot automatically from the major-mode | 147 | The notion of a ``project'' used by Eglot is the same Emacs uses |
| 150 | hook of the mode used for the programming language; see @ref{Starting | 148 | (@pxref{Projects,,, emacs, GNU Emacs Manual}): in the simplest case, |
| 151 | Eglot}. | 149 | the ``project'' is the single file you are editing, but it can also be |
| 150 | all the files in a single directory or a directory tree under some | ||
| 151 | version control system, such as Git. | ||
| 152 | |||
| 153 | There are alternate ways of starting Eglot; see @ref{Starting Eglot} | ||
| 154 | for details. | ||
| 152 | 155 | ||
| 153 | @item | 156 | @item |
| 154 | Use Eglot. | 157 | Use Eglot. |
| @@ -344,6 +347,12 @@ starting an Eglot session is non-interactive, so it should be used | |||
| 344 | only when you are confident that Eglot can be started reliably for any | 347 | only when you are confident that Eglot can be started reliably for any |
| 345 | file which may be visited with the major-mode in question. | 348 | file which may be visited with the major-mode in question. |
| 346 | 349 | ||
| 350 | Note that it's often difficult to establish this confidence fully, so | ||
| 351 | it may be wise to use the interactive command @code{eglot} instead. | ||
| 352 | You only need to invoke it once per project, as all other files | ||
| 353 | visited within the same project will automatically be managed with no | ||
| 354 | further user intervention needed. | ||
| 355 | |||
| 347 | When Eglot connects to a language server for the first time in an | 356 | When Eglot connects to a language server for the first time in an |
| 348 | Emacs session, it runs the hook @code{eglot-connect-hook} | 357 | Emacs session, it runs the hook @code{eglot-connect-hook} |
| 349 | (@pxref{Eglot Variables}). | 358 | (@pxref{Eglot Variables}). |