summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPo Lu <luangruo@yahoo.com>2023-04-28 11:51:01 +0800
committerPo Lu <luangruo@yahoo.com>2023-04-28 11:51:01 +0800
commita97c382682b483b34351c6757e54e3139fa27f89 (patch)
tree497b1b52dd955f593a0a39f1032e3fd55aabcc35 /doc
parentdbd74657908e67e2a5001fbe440fb2a01a2f01af (diff)
parenta40f18162377d2f9a78d7443fd0f8106c8c28c3d (diff)
downloademacs-a97c382682b483b34351c6757e54e3139fa27f89.tar.gz
Merge from origin/emacs-29
a40f1816237 Fix two crashes upon startup 44ebd9cbd56 Eglot: explain how to update Eglot in manual (bug#62720) 941ef044f2e Eglot: fix edge case when deleting inlay hint overlays a365984d9e1 package-upgrade[-all]: Expand docstrings to note the curr... f965f35b33b Rename all functions called package-*-update-* to package... 31b58161bb5 Fix FOR_EACH_TAIL in c-ts-mode (bug#62951) 0cf6e0998ba * Makefile.in (distclean): Remove the 'native-lisp' direc... 933705d61e5 Improve greek-ibycus4 input method # Conflicts: # etc/NEWS
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/package.texi14
-rw-r--r--doc/misc/eglot.texi32
2 files changed, 38 insertions, 8 deletions
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi
index 2b03399b0a7..d1766026db2 100644
--- a/doc/emacs/package.texi
+++ b/doc/emacs/package.texi
@@ -329,15 +329,15 @@ version of the package, a newer version is also installed.
@section Package Installation
@findex package-install
-@findex package-update
-@findex package-update-all
+@findex package-upgrade
+@findex package-upgrade-all
Packages are most conveniently installed using the package menu
(@pxref{Package Menu}), but you can also use the command @kbd{M-x
package-install}. This prompts for the name of a package with the
@samp{available} status, then downloads and installs it. Similarly,
-if you want to update a package, you can use the @kbd{M-x
-package-update} command, and if you just want to update all the
-packages, you can use the @kbd{M-x package-update-all} command.
+if you want to upgrade a package, you can use the @kbd{M-x
+package-upgrade} command, and if you want to upgrade all the packages,
+you can use the @kbd{M-x package-upgrade-all} command.
@cindex package requirements
A package may @dfn{require} certain other packages to be installed,
@@ -551,8 +551,8 @@ bugs.
source code for a package directly from source. The command will also
automatically ensure that all files are byte-compiled and auto-loaded,
just like with a regular package. Packages installed this way behave
-just like any other package. You can update them using
-@code{package-update} or @code{package-update-all} and delete them
+just like any other package. You can upgrade them using
+@code{package-upgrade} or @code{package-upgrade-all} and delete them
again using @code{package-delete}. They are even displayed in the
regular package listing. If you just wish to clone the source of a
package, without adding it to the package list, use
diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi
index fc5449b0e8d..4599b78ba56 100644
--- a/doc/misc/eglot.texi
+++ b/doc/misc/eglot.texi
@@ -1265,7 +1265,7 @@ is serialized by Eglot to the following JSON text:
@chapter Troubleshooting Eglot
@cindex troubleshooting Eglot
-This section documents commands and variables that can be used to
+This chapter documents commands and variables that can be used to
troubleshoot Eglot problems. It also provides guidelines for
reporting Eglot bugs in a way that facilitates their resolution.
@@ -1275,6 +1275,8 @@ pop up special buffers that can be used to inspect the communications
between the Eglot and language server. In many cases, this will
indicate the problems or at least provide a hint.
+@node Performance
+@section Performance
@cindex performance
A common and easy-to-fix cause of performance problems is the length
of the Eglot events buffer because it represent additional work that
@@ -1289,6 +1291,30 @@ techniques to improve their performance. Often, this can be tweaked
by changing the server configuration (@pxref{Advanced server
configuration}).
+@node Getting the latest version
+@section Getting the latest version
+@cindex updating Eglot
+
+To install the latest Eglot on an Emacs version that does not bundle
+Eglot, use @kbd{M-x package-install}.
+
+Often, a newer Eglot version exists that has fixed a longstanding bug,
+has more LSP features, or just better support for a particular
+language server. Recent Eglot versions can self-update via the
+command @kbd{M-x eglot-update}. This will replace any currently
+installed version with the newest one available from the ELPA archives
+configured in @code{package-archives}.
+
+You may update though other methods, such as @code{package-install},
+@code{use-package}, @code{list-packages} or the newer
+@code{package-update}. However, do read the docstrings of these
+commands, as some may not work in exactly the same way across Emacs
+versions, meaning your configuration may be not portable.
+
+@node Reporting bugs
+@section Reporting bugs
+@cindex bug reports
+
If you think you have found a bug, we want to hear about it. Before
reporting a bug, keep in mind that interaction with language servers
represents a large quantity of unknown variables. Therefore, it is
@@ -1332,6 +1358,10 @@ public Git repository.
Include versions of the software used. The Emacs version can be
obtained with @kbd{M-x emacs-version}.
+We welcome bug reports about all Eglot versions, but it is helpful to
+first check if the problem isn't already fixed in the latest version
+(@pxref{Getting the latest version}).
+
It's also essential to include the version of ELPA packages that are
explicitly or implicitly loaded. The optional but popular Company or
Markdown packages are distributed as GNU ELPA packages, not to mention