aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoão Távora2023-03-21 14:55:57 +0000
committerJoão Távora2023-03-23 10:26:50 +0000
commit1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96 (patch)
treec8f75b0958b43993b453992e1801f4eeae323e3c
parentbcd02cf5127ecfe6d6ce4ac316f881246c49db4f (diff)
downloademacs-1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96.tar.gz
emacs-1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96.zip
; Minor copyedits to Eglot manual
* doc/misc/eglot.texi (Troubleshooting Eglot): Minor fixes.
-rw-r--r--doc/misc/eglot.texi28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi
index defdf59e865..fc5449b0e8d 100644
--- a/doc/misc/eglot.texi
+++ b/doc/misc/eglot.texi
@@ -1298,9 +1298,9 @@ user.
1298 1298
1299To report an Eglot bug, send e-mail to @email{bug-gnu-emacs@@gnu.org}. 1299To report an Eglot bug, send e-mail to @email{bug-gnu-emacs@@gnu.org}.
1300 1300
1301Get acquainted with Emacs's bug reporting guidelines (@pxref{Bugs,,, 1301To understand how to write this email, get acquainted with Emacs's bug
1302emacs, GNU Emacs Manual}). Then, follow this checklist specific to 1302reporting guidelines (@pxref{Bugs,,, emacs, GNU Emacs Manual}). Then,
1303Eglot bug rerpots. 1303follow this Eglot-specific checklist:
1304 1304
1305@enumerate 1305@enumerate
1306@item 1306@item
@@ -1341,18 +1341,18 @@ since they are usually implicitly loaded when visiting a file in that
1341language. 1341language.
1342 1342
1343ELPA packages usually live in @code{~/.emacs.d/elpa} (or what is in 1343ELPA packages usually live in @code{~/.emacs.d/elpa} (or what is in
1344@code{package-user-dir}). Please show the listing of files in that 1344@code{package-user-dir}). Including a listing of files in that
1345directory as well. 1345directory is a way to tell the maintainers about ELPA package
1346versions.
1346 1347
1347@item 1348@item
1348Include a recipe to replicate the problem with @emph{a clean Emacs 1349Include a recipe to replicate the problem with @emph{a clean Emacs
1349run}. This means @kbd{emacs -Q -f package-initialize} invocation 1350run}. The invocation @code{emacs -Q -f package-initialize} starts
1350which starts Emacs with no configuration and initializes the ELPA 1351Emacs with no configuration and initializes the ELPA packages. A very
1351packages. A very minimal (no more that 10 lines) @file{.emacs} 1352minimal @file{.emacs} initialization file (10 lines or less) is also
1352initialization file is also acceptable and good means to describe 1353acceptable and good means to describe changes to variables.
1353changes to variables.
1354 1354
1355There is usually no need to include @kbd{require} statements in the 1355There is usually no need to include @code{require} statements in the
1356recipe, as Eglot's functionality uses autoloads. 1356recipe, as Eglot's functionality uses autoloads.
1357 1357
1358Likewise, there is rarely the need to use things like 1358Likewise, there is rarely the need to use things like
@@ -1364,9 +1364,9 @@ adding to hooks with @code{add-hook}. Prefer starting Eglot with
1364@item 1364@item
1365Make sure to double check all the above elements and re-run the recipe 1365Make sure to double check all the above elements and re-run the recipe
1366to see that the problem is reproducible. Following the recipe should 1366to see that the problem is reproducible. Following the recipe should
1367produce event transcript and error backtraces that are exactly the 1367produce event transcript and error backtraces that are very similar to
1368same or very similar to the ones you included. If the problem only 1368the ones you included. If the problem only happens sometimes, mention
1369happens sometimes, include this information in your bug report. 1369this in your report.
1370@end enumerate 1370@end enumerate
1371 1371
1372Please keep in mind that some problems reported against Eglot may 1372Please keep in mind that some problems reported against Eglot may