From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 20 Oct 2022 17:17:45 +0000 (+0300)
Subject: Mention Eglot in the Emacs user manual
X-Git-Tag: emacs-29.0.90~1616^2~520
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3bab83289415f5169e312064c8fc46a0674b8d9e;p=emacs.git

Mention Eglot in the Emacs user manual

* doc/emacs/maintaining.texi (Xref):
* doc/emacs/programs.texi (Symbol Completion, Imenu): Mention Eglot.
---

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index ad4a3ea3506..94171b3a089 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -2094,6 +2094,13 @@ definitions of symbols.  (One disadvantage of this kind of backend is
 that it only knows about subunits that were loaded into the
 interpreter.)
 
+@item
+If Eglot is activated for the current buffer's project
+(@pxref{Projects}) and the current buffer's major mode, Eglot consults
+an external language server program and provides the data supplied by
+the server regarding the definitions of the identifiers in the
+project.  @xref{Eglot Features,,, eglot, Eglot: The Emacs LSP Client}.
+
 @item
 An external program can extract references by scanning the relevant
 files, and build a database of these references.  A backend can then
diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi
index 818deb39415..b5e577d96a4 100644
--- a/doc/emacs/programs.texi
+++ b/doc/emacs/programs.texi
@@ -287,6 +287,13 @@ they occur in the buffer; if you want alphabetic sorting, use the
 symbol @code{imenu--sort-by-name} as the value.  You can also
 define your own comparison function by writing Lisp code.
 
+  If Eglot is activated for the current buffer's project
+(@pxref{Projects}) and the current buffer's major mode, Eglot provides
+its own facility for producing the buffer's index based on the
+analysis of the program source by the language-server which manages
+the current buffer.  @xref{Eglot Features,,, eglot, Eglot: The Emacs
+LSP Client}.
+
   Imenu provides the information to guide Which Function mode
 @ifnottex
 (@pxref{Which Function}).
@@ -1438,6 +1445,13 @@ uses the available support facilities to come up with the completion
 candidates:
 
 @itemize @bullet
+@item
+If Eglot is activated for the current buffer's project
+(@pxref{Projects}) and the current buffer's major mode, the command
+tries to use the corresponding language server for producing the list
+of completion candidates.  @xref{Eglot Features,,, eglot, Eglot: The
+Emacs LSP Client}.
+
 @item
 If Semantic mode is enabled (@pxref{Semantic}), the command tries to
 use the Semantic parser data for completion.