about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Diebold <flodiebold@gmail.com>2020-02-08 16:02:37 +0100
committerFlorian Diebold <flodiebold@gmail.com>2020-02-08 16:15:58 +0100
commit134cc70097f2386bf3af6a15e3c29de9c317ed24 (patch)
treec012a1fb7f7e97a34ff65559c15413a179a59e60
parentc27ec6908793e3b1706d683dc2c2d367ac8fc061 (diff)
downloadrust-134cc70097f2386bf3af6a15e3c29de9c317ed24.tar.gz
rust-134cc70097f2386bf3af6a15e3c29de9c317ed24.zip
Docs cleanups
-rw-r--r--docs/dev/README.md12
-rw-r--r--docs/user/README.md18
2 files changed, 12 insertions, 18 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index d3072778678..732e4bdd30d 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -43,7 +43,7 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
 
 We use GitHub Actions for CI. Most of the things, including formatting, are checked by
 `cargo test` so, if `cargo test` passes locally, that's a good sign that CI will
-be green as well. The only exception is that long-running by default a skipped locally.
+be green as well. The only exception is that some long-running tests are skipped locally by default.
 Use `env RUN_SLOW_TESTS=1 cargo test` to run the full suite.
 
 We use bors-ng to enforce the [not rocket science](https://graydon2.dreamwidth.org/1597.html) rule.
@@ -54,9 +54,9 @@ You can run `cargo xtask install-pre-commit-hook` to install git-hook to run rus
 
 All Rust code lives in the `crates` top-level directory, and is organized as a
 single Cargo workspace. The `editors` top-level directory contains code for
-integrating with editors. Currently, it contains plugins for VS Code (in
-typescript) and Emacs (in elisp). The `docs` top-level directory contains both
-developer and user documentation.
+integrating with editors. Currently, it contains the plugin for VS Code (in
+typescript). The `docs` top-level directory contains both developer and user
+documentation.
 
 We have some automation infra in Rust in the `xtask` package. It contains
 stuff like formatting checking, code generation and powers `cargo xtask install`.
@@ -107,8 +107,8 @@ If I need to fix something simultaneously in the server and in the client, I
 feel even more sad. I don't have a specific workflow for this case.
 
 Additionally, I use `cargo run --release -p ra_cli -- analysis-stats
-path/to/some/rust/crate` to run a batch analysis. This is primaraly useful for
-performance optimiations, or for bug minimization.
+path/to/some/rust/crate` to run a batch analysis. This is primarily useful for
+performance optimizations, or for bug minimization.
 
 # Logging
 
diff --git a/docs/user/README.md b/docs/user/README.md
index 18867cd11af..da99a063c68 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -5,8 +5,7 @@ install lsp server, clone the repository and then run `cargo xtask install
 ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which
 you should be able to use it with any LSP-compatible editor. We use custom
 extensions to LSP, so special client-side support is required to take full
-advantage of rust-analyzer. This repository contains support code for VS Code
-and Emacs.
+advantage of rust-analyzer. This repository contains support code for VS Code.
 
 ```
 $ git clone git@github.com:rust-analyzer/rust-analyzer && cd rust-analyzer
@@ -130,17 +129,12 @@ host.
 
 ## Emacs
 
-Prerequisites:
-
-`emacs-lsp`, `dash` and `ht` packages.
-
-Installation:
+* install recent version of `emacs-lsp` package by following the instructions [here][emacs-lsp]
+* set `lsp-rust-server` to `'rust-analyzer`
+* run `lsp` in a Rust buffer
+* (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys
 
-* add
-[rust-analyzer.el](../../editors/emacs/rust-analyzer.el)
-to load path and require it in `init.el`
-* run `lsp` in a rust buffer
-* (Optionally) bind commands like `rust-analyzer-join-lines`, `rust-analyzer-extend-selection` and `rust-analyzer-expand-macro` to keys, and enable `rust-analyzer-inlay-hints-mode` to get inline type hints
+[emacs-lsp]: https://github.com/emacs-lsp/lsp-mode
 
 
 ## Vim and NeoVim (coc-rust-analyzer)