Changelog #137

Author: lnicola

generated_assists.adoc

@@ -29,7 +29,7 @@ Run build scripts (`build.rs`) for more precise code analysis.
 --
 Override the command rust-analyzer uses to run build scripts and
 build procedural macros. The command is required to output json
-and should therefor include `--message-format=json` or a similar
+and should therefore include `--message-format=json` or a similar
 option.
 
 By default, a cargo invocation will be constructed for the configured
@@ -44,7 +44,7 @@ cargo check --quiet --workspace --message-format=json --all-targets
 +
 --
 Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
-avoid compiling unnecessary things.
+avoid checking unnecessary things.
 --
 [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
 +
@@ -99,21 +99,24 @@ Extra arguments for `cargo check`.
 List of features to activate. Defaults to
 `#rust-analyzer.cargo.features#`.
 
-Set to `"all"` to pass `--all-features` to cargo.
+Set to `"all"` to pass `--all-features` to Cargo.
 --
 [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
 +
 --
-Whether to pass `--no-default-features` to cargo. Defaults to
+Whether to pass `--no-default-features` to Cargo. Defaults to
 `#rust-analyzer.cargo.noDefaultFeatures#`.
 --
 [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
 +
 --
-Override the command rust-analyzer uses to  run build scripts and
-build procedural macros. The command is required to output json
-and should therefor include `--message-format=json` or a similar
-option.
+Override the command rust-analyzer uses instead of `cargo check` for
+diagnostics on save. The command is required to output json and
+should therefor include `--message-format=json` or a similar option.
+
+If you're changing this because you're using some tool wrapping
+Cargo, you might also want to change
+`#rust-analyzer.cargo.buildScripts.overrideCommand#`.
 
 An example command would be:
 

generated_config.adoc

@@ -1,50 +1,50 @@
 //! Generated by `sourcegen_diagnostic_docs`, do not edit by hand.
 
 === break-outside-of-loop
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/break_outside_of_loop.rs#L3[break_outside_of_loop.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/break_outside_of_loop.rs#L3[break_outside_of_loop.rs]
 
 This diagnostic is triggered if the `break` keyword is used outside of a loop.
 
 
 === inactive-code
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/inactive_code.rs#L6[inactive_code.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/inactive_code.rs#L6[inactive_code.rs]
 
 This diagnostic is shown for code with inactive `#[cfg]` attributes.
 
 
 === incorrect-ident-case
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/incorrect_case.rs#L13[incorrect_case.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/incorrect_case.rs#L13[incorrect_case.rs]
 
 This diagnostic is triggered if an item name doesn't follow https://doc.rust-lang.org/1.0.0/style/style/naming/README.html[Rust naming convention].
 
 
 === invalid-derive-target
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/invalid_derive_target.rs#L3[invalid_derive_target.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/invalid_derive_target.rs#L3[invalid_derive_target.rs]
 
 This diagnostic is shown when the derive attribute is used on an item other than a `struct`,
 `enum` or `union`.
 
 
 === macro-error
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/macro_error.rs#L3[macro_error.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/macro_error.rs#L3[macro_error.rs]
 
 This diagnostic is shown for macro expansion errors.
 
 
 === malformed-derive
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/malformed_derive.rs#L3[malformed_derive.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/malformed_derive.rs#L3[malformed_derive.rs]
 
 This diagnostic is shown when the derive attribute has invalid input.
 
 
 === mismatched-arg-count
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/mismatched_arg_count.rs#L10[mismatched_arg_count.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/mismatched_arg_count.rs#L10[mismatched_arg_count.rs]
 
 This diagnostic is triggered if a function is invoked with an incorrect amount of arguments.
 
 
 === missing-fields
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_fields.rs#L17[missing_fields.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_fields.rs#L17[missing_fields.rs]
 
 This diagnostic is triggered if record lacks some fields that exist in the corresponding structure.
 
@@ -58,83 +58,83 @@ let a = A { a: 10 };
 
 
 === missing-match-arm
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_match_arms.rs#L5[missing_match_arms.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_match_arms.rs#L5[missing_match_arms.rs]
 
 This diagnostic is triggered if `match` block is missing one or more match arms.
 
 
 === missing-unsafe
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_unsafe.rs#L3[missing_unsafe.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/missing_unsafe.rs#L3[missing_unsafe.rs]
 
 This diagnostic is triggered if an operation marked as `unsafe` is used outside of an `unsafe` function or block.
 
 
 === no-such-field
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/no_such_field.rs#L11[no_such_field.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/no_such_field.rs#L11[no_such_field.rs]
 
 This diagnostic is triggered if created structure does not have field provided in record.
 
 
 === replace-filter-map-next-with-find-map
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/replace_filter_map_next_with_find_map.rs#L11[replace_filter_map_next_with_find_map.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/replace_filter_map_next_with_find_map.rs#L11[replace_filter_map_next_with_find_map.rs]
 
 This diagnostic is triggered when `.filter_map(..).next()` is used, rather than the more concise `.find_map(..)`.
 
 
 === type-mismatch
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/type_mismatch.rs#L11[type_mismatch.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/type_mismatch.rs#L11[type_mismatch.rs]
 
 This diagnostic is triggered when the type of an expression does not match
 the expected type.
 
 
 === unimplemented-builtin-macro
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unimplemented_builtin_macro.rs#L3[unimplemented_builtin_macro.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unimplemented_builtin_macro.rs#L3[unimplemented_builtin_macro.rs]
 
 This diagnostic is shown for builtin macros which are not yet implemented by rust-analyzer
 
 
 === unlinked-file
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unlinked_file.rs#L17[unlinked_file.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unlinked_file.rs#L17[unlinked_file.rs]
 
 This diagnostic is shown for files that are not included in any crate, or files that are part of
 crates rust-analyzer failed to discover. The file will not have IDE features available.
 
 
 === unnecessary-braces
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/useless_braces.rs#L8[useless_braces.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/useless_braces.rs#L8[useless_braces.rs]
 
 Diagnostic for unnecessary braces in `use` items.
 
 
 === unresolved-extern-crate
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_extern_crate.rs#L3[unresolved_extern_crate.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_extern_crate.rs#L3[unresolved_extern_crate.rs]
 
 This diagnostic is triggered if rust-analyzer is unable to discover referred extern crate.
 
 
 === unresolved-import
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_import.rs#L3[unresolved_import.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_import.rs#L3[unresolved_import.rs]
 
 This diagnostic is triggered if rust-analyzer is unable to resolve a path in
 a `use` declaration.
 
 
 === unresolved-macro-call
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_macro_call.rs#L3[unresolved_macro_call.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_macro_call.rs#L3[unresolved_macro_call.rs]
 
 This diagnostic is triggered if rust-analyzer is unable to resolve the path
 to a macro in a macro invocation.
 
 
 === unresolved-module
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_module.rs#L8[unresolved_module.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_module.rs#L8[unresolved_module.rs]
 
 This diagnostic is triggered if rust-analyzer is unable to discover referred module.
 
 
 === unresolved-proc-macro
-**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_proc_macro.rs#L5[unresolved_proc_macro.rs]
+**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-diagnostics/src/handlers/unresolved_proc_macro.rs#L5[unresolved_proc_macro.rs]
 
 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),