diff options
author | João Távora <joaotavora@gmail.com> | 2023-03-21 14:55:57 +0000 |
---|---|---|
committer | João Távora <joaotavora@gmail.com> | 2023-03-23 10:26:50 +0000 |
commit | 1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96 (patch) | |
tree | c8f75b0958b43993b453992e1801f4eeae323e3c /doc/misc/eglot.texi | |
parent | bcd02cf5127ecfe6d6ce4ac316f881246c49db4f (diff) | |
download | emacs-1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96.tar.gz emacs-1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96.tar.bz2 emacs-1bc9dfc5bee5c69d82f9a3ed448ba2fefea82a96.zip |
; Minor copyedits to Eglot manual
* doc/misc/eglot.texi (Troubleshooting Eglot): Minor fixes.
Diffstat (limited to 'doc/misc/eglot.texi')
-rw-r--r-- | doc/misc/eglot.texi | 28 |
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. To report an Eglot bug, send e-mail to @email{bug-gnu-emacs@@gnu.org}. -Get acquainted with Emacs's bug reporting guidelines (@pxref{Bugs,,, -emacs, GNU Emacs Manual}). Then, follow this checklist specific to -Eglot bug rerpots. +To understand how to write this email, get acquainted with Emacs's bug +reporting guidelines (@pxref{Bugs,,, emacs, GNU Emacs Manual}). Then, +follow this Eglot-specific checklist: @enumerate @item @@ -1341,18 +1341,18 @@ since they are usually implicitly loaded when visiting a file in that language. ELPA packages usually live in @code{~/.emacs.d/elpa} (or what is in -@code{package-user-dir}). Please show the listing of files in that -directory as well. +@code{package-user-dir}). Including a listing of files in that +directory is a way to tell the maintainers about ELPA package +versions. @item Include a recipe to replicate the problem with @emph{a clean Emacs -run}. This means @kbd{emacs -Q -f package-initialize} invocation -which starts Emacs with no configuration and initializes the ELPA -packages. A very minimal (no more that 10 lines) @file{.emacs} -initialization file is also acceptable and good means to describe -changes to variables. +run}. The invocation @code{emacs -Q -f package-initialize} starts +Emacs with no configuration and initializes the ELPA packages. A very +minimal @file{.emacs} initialization file (10 lines or less) is also +acceptable and good means to describe changes to variables. -There is usually no need to include @kbd{require} statements in the +There is usually no need to include @code{require} statements in the recipe, as Eglot's functionality uses autoloads. Likewise, there is rarely the need to use things like @@ -1364,9 +1364,9 @@ adding to hooks with @code{add-hook}. Prefer starting Eglot with @item Make sure to double check all the above elements and re-run the recipe to see that the problem is reproducible. Following the recipe should -produce event transcript and error backtraces that are exactly the -same or very similar to the ones you included. If the problem only -happens sometimes, include this information in your bug report. +produce event transcript and error backtraces that are very similar to +the ones you included. If the problem only happens sometimes, mention +this in your report. @end enumerate Please keep in mind that some problems reported against Eglot may |