diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-01-03 18:22:07 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2021-01-03 18:22:07 +0000 |
commit | 5b86ff3e91838e58397ec39502d85056e46fcfcb (patch) | |
tree | baa1664687e13eaa3f8fb408a07990e8eee3ecfd /docs | |
parent | 96ab76ca04e2674c28846833873747cb110828ee (diff) | |
parent | 10c9efc24bc471f05be80a03ae02dc1398d84d6c (diff) |
Merge #7113
7113: Manual updates r=matklad a=tekul
Add some details on how to build the manual and some clarification on how to deal with "proc macro2 warnings.
For context, this arose from [this question](https://users.rust-lang.org/t/how-to-disable-rust-analyzer-proc-macro-warnings-in-neovim/53150) on users.rust-lang.org.
Co-authored-by: Luke Taylor <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user/manual.adoc | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 75445a02e..266baffa1 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -18,6 +18,9 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se | |||
18 | [.lead] | 18 | [.lead] |
19 | To improve this document, send a pull request: + | 19 | To improve this document, send a pull request: + |
20 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] | 20 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] |
21 | |||
22 | The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo xtask codegen` to create these and then `asciidoctor manual.adoc` to create an HTML copy. | ||
23 | |||
21 | ==== | 24 | ==== |
22 | 25 | ||
23 | If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum. | 26 | If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum. |