From 6168a6f1ca22000158e2896348e54ba47d5d80db Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Thu, 31 Dec 2020 16:41:32 +0000 Subject: Expand contributing "tip" in manual.adoc - Add link to asciidoc website - Explain how to create the generated adoc files from the source code - How to run asciidoctor to generate the manual --- docs/user/manual.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index d4121b401..8ed7b041f 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 [.lead] To improve this document, send a pull request: + https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] + +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. + ==== 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. -- cgit v1.2.3 From 10c9efc24bc471f05be80a03ae02dc1398d84d6c Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Thu, 31 Dec 2020 22:28:55 +0000 Subject: Expand doc on dealing with "proc macro not expanded" Added the error message to the doc for the UnresolvedProcMacro diagnostic, explaining that either enabling the procMacro setting or disabling this diagnostic should make the warnings go away. --- crates/hir_def/src/diagnostics.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/hir_def/src/diagnostics.rs b/crates/hir_def/src/diagnostics.rs index c71266dc0..ab3f059ce 100644 --- a/crates/hir_def/src/diagnostics.rs +++ b/crates/hir_def/src/diagnostics.rs @@ -133,6 +133,10 @@ impl Diagnostic for InactiveCode { // This diagnostic is shown when a procedural macro can not be found. This usually means that // procedural macro support is simply disabled (and hence is only a weak hint instead of an error), // but can also indicate project setup problems. +// +// If you are seeing a lot of "proc macro not expanded" warnings, you can add this option to the +// `rust-analyzer.diagnostics.disabled` list to prevent them from showing. Alternatively you can +// enable support for procedural macros (see `rust-analyzer.procMacro.enable`). #[derive(Debug, Clone, Eq, PartialEq)] pub struct UnresolvedProcMacro { pub file: HirFileId, -- cgit v1.2.3