procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Minor copyedits to Eglot manual

Browse source 
* doc/misc/eglot.texi (Troubleshooting Eglot): Minor fixes.
This commit is contained in:
João Távora 2023-03-21 14:55:57 +00:00
parent bcd02cf512
commit 1bc9dfc5be
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

28
doc/misc/eglot.texi
View file

@ -1298,9 +1298,9 @@ user.
To report an Eglot bug, send e-mail to @email{bug-gnu-emacs@@gnu.org}. 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,,, To understand how to write this email, get acquainted with Emacs's bug
emacs, GNU Emacs Manual}). Then, follow this checklist specific to reporting guidelines (@pxref{Bugs,,, emacs, GNU Emacs Manual}). Then,
Eglot bug rerpots. follow this Eglot-specific checklist:
@enumerate @enumerate
@item @item
@ -1341,18 +1341,18 @@ since they are usually implicitly loaded when visiting a file in that
language. language.
ELPA packages usually live in @code{~/.emacs.d/elpa} (or what is in 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 @code{package-user-dir}). Including a listing of files in that
directory as well. directory is a way to tell the maintainers about ELPA package
versions.
@item @item
Include a recipe to replicate the problem with @emph{a clean Emacs Include a recipe to replicate the problem with @emph{a clean Emacs
run}. This means @kbd{emacs -Q -f package-initialize} invocation run}. The invocation @code{emacs -Q -f package-initialize} starts
which starts Emacs with no configuration and initializes the ELPA Emacs with no configuration and initializes the ELPA packages. A very
packages. A very minimal (no more that 10 lines) @file{.emacs} minimal @file{.emacs} initialization file (10 lines or less) is also
initialization file is also acceptable and good means to describe acceptable and good means to describe changes to variables.
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. recipe, as Eglot's functionality uses autoloads.
Likewise, there is rarely the need to use things like 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 @item
Make sure to double check all the above elements and re-run the recipe 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 to see that the problem is reproducible. Following the recipe should
produce event transcript and error backtraces that are exactly the produce event transcript and error backtraces that are very similar to
same or very similar to the ones you included. If the problem only the ones you included. If the problem only happens sometimes, mention
happens sometimes, include this information in your bug report. this in your report.
@end enumerate @end enumerate
Please keep in mind that some problems reported against Eglot may Please keep in mind that some problems reported against Eglot may