[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eglot 99f8d7b 17/49: Per #604: mention common installat
From: |
Stefan Monnier |
Subject: |
[elpa] externals/eglot 99f8d7b 17/49: Per #604: mention common installation pitfalls in README.md |
Date: |
Wed, 17 Mar 2021 18:41:45 -0400 (EDT) |
branch: externals/eglot
commit 99f8d7b3b9848ecc9fe4c990be7e9af2b2907ba3
Author: João Távora <joaotavora@gmail.com>
Commit: João Távora <joaotavora@gmail.com>
Per #604: mention common installation pitfalls in README.md
* README.md (1-2-3): Mention dependencies
---
README.md | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d42eefc..cfdc850 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,16 @@ Now find some source file, any source file, and type `M-x
eglot`.
*That's it*. If you're lucky, this guesses the LSP program to start
for the language you're using. Otherwise, it prompts you to enter one.
+### _1-2-3-pitfall!_
+
+By design, Eglot doesn't depend on anything but Emacs. But there
+_are_ ELPA dependencies to newer versions of so-called "core packages"
+developed _in the Emacs mainline_. So unless you're using a
+bleeding-edge Emacs, where loading `eglot.el` is all you'd need to do,
+make sure your package system pulls in and loads the newest
+`project.el`, `xref.el`, `eldoc.el`, etc... In case of trouble `M-x
+find-library` can help you tell if that happened.
+
<a name="connecting"></a>
# Connecting to a server
@@ -241,9 +251,10 @@ file in your project. The commands don't need to be
Eglot-specific,
either:
```lisp
-(define-key eglot-mode-map (kbd "C-c h") 'eglot-help-at-point)
-(define-key eglot-mode-map (kbd "<f6>") 'xref-find-definitions)
+(define-key eglot-mode-map (kbd "C-c r") 'eglot-rename)
(define-key eglot-mode-map (kbd "C-c o") 'eglot-code-action-organize-imports)
+(define-key eglot-mode-map (kbd "C-c h") 'eldoc)
+(define-key eglot-mode-map (kbd "<f6>") 'xref-find-definitions)
```
<a name="customization"></a>
- [elpa] externals/eglot a43289e 25/49: Fix #616: also override global flymake-diagnostic-functions, (continued)
- [elpa] externals/eglot a43289e 25/49: Fix #616: also override global flymake-diagnostic-functions, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot fc4c324 29/49: Fix #567: update elixir-ls link in README.md, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 7918fac 43/49: Close #637: Add TRAMP support, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 33e83ba 44/49: Fix #638: convert colon to hex in URI, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot bf4a7aa 31/49: Fix #406: mention eglot-stay-out-of in README.md, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 65aadca 46/49: Fix #620: simplify eglot--apply-workspace-edit, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 97ed4ca 49/49: Close #643: add new command eglot-shutdown-all, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot f9df418 06/49: Fix #584: Define a face for symbol highlight, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot cb58b72 15/49: Close #603: add fortls for Fotran (f90-mode), Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 147f3b0 16/49: Close #411: offer shortcut commands to commonly invoked code actions, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 99f8d7b 17/49: Per #604: mention common installation pitfalls in README.md,
Stefan Monnier <=
- [elpa] externals/eglot 2879b83 19/49: * README.md: Mention Google Open Source Peer Bonus, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot d5b840b 20/49: Fix #606, #Fix 608: fix bug in eglot-code-actions, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot eac5264 21/49: Fix #609: flush pending changes to server before code actions request, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot f68f829 26/49: Close #566: prefer typescript-language-server for JS&TS, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot c73f5ed 27/49: Fix #612: remove duplicate entry for "Registration" LSP type, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 4ae5a44 28/49: Fix #568: update gopls URL in README.md, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 8d00f8b 32/49: Per #602: speed up glob matching 2x, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot e57be55 36/49: Fix #502: silence messages while formatting markup, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot 398b81e 35/49: Per #602: simplify dir-watching strategy of w/didChangeWatchedFiles, Stefan Monnier, 2021/03/17
- [elpa] externals/eglot a2d1fc9 37/49: Fix #625: handle null reply for textDocument/definition, Stefan Monnier, 2021/03/17