Skip to content

Commit 5b86ff3

Browse files
bors[bot]tekul
andauthored
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]>
2 parents 96ab76c + 10c9efc commit 5b86ff3

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

crates/hir_def/src/diagnostics.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,10 @@ impl Diagnostic for InactiveCode {
133133
// This diagnostic is shown when a procedural macro can not be found. This usually means that
134134
// procedural macro support is simply disabled (and hence is only a weak hint instead of an error),
135135
// but can also indicate project setup problems.
136+
//
137+
// If you are seeing a lot of "proc macro not expanded" warnings, you can add this option to the
138+
// `rust-analyzer.diagnostics.disabled` list to prevent them from showing. Alternatively you can
139+
// enable support for procedural macros (see `rust-analyzer.procMacro.enable`).
136140
#[derive(Debug, Clone, Eq, PartialEq)]
137141
pub struct UnresolvedProcMacro {
138142
pub file: HirFileId,

docs/user/manual.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se
1818
[.lead]
1919
To improve this document, send a pull request: +
2020
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+
2124
====
2225

2326
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.

0 commit comments

Comments
 (0)