diff options
| author | Aleksey Kladov <[email protected]> | 2021-01-05 10:09:06 +0000 |
|---|---|---|
| committer | Aleksey Kladov <[email protected]> | 2021-01-05 10:09:06 +0000 |
| commit | d7741d1610e4dbcc058341273e15265b7aaa4797 (patch) | |
| tree | 67aae720151946755e3e7e74375af754202b6215 /docs/user | |
| parent | 0708bfeb7270923be5a2059ad5b99de183e667ba (diff) | |
Allow `#anchor` linking of config options
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/generated_config.adoc | 106 |
1 files changed, 53 insertions, 53 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 3025dc8d6..e109f2b01 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
| @@ -1,106 +1,106 @@ | |||
| 1 | rust-analyzer.assist.importMergeBehaviour (default: `"full"`):: | 1 | [[rust-analyzer.assist.importMergeBehaviour]]rust-analyzer.assist.importMergeBehaviour (default: `"full"`):: |
| 2 | The strategy to use when inserting new imports or merging imports. | 2 | The strategy to use when inserting new imports or merging imports. |
| 3 | rust-analyzer.assist.importPrefix (default: `"plain"`):: | 3 | [[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`):: |
| 4 | The path structure for newly inserted paths to use. | 4 | The path structure for newly inserted paths to use. |
| 5 | rust-analyzer.callInfo.full (default: `true`):: | 5 | [[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`):: |
| 6 | Show function name and docs in parameter hints. | 6 | Show function name and docs in parameter hints. |
| 7 | rust-analyzer.cargo.autoreload (default: `true`):: | 7 | [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`):: |
| 8 | Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes. | 8 | Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes. |
| 9 | rust-analyzer.cargo.allFeatures (default: `false`):: | 9 | [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`):: |
| 10 | Activate all available features. | 10 | Activate all available features. |
| 11 | rust-analyzer.cargo.features (default: `[]`):: | 11 | [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: |
| 12 | List of features to activate. | 12 | List of features to activate. |
| 13 | rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`):: | 13 | [[rust-analyzer.cargo.loadOutDirsFromCheck]]rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`):: |
| 14 | Run `cargo check` on startup to get the correct value for package OUT_DIRs. | 14 | Run `cargo check` on startup to get the correct value for package OUT_DIRs. |
| 15 | rust-analyzer.cargo.noDefaultFeatures (default: `false`):: | 15 | [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: |
| 16 | Do not activate the `default` feature. | 16 | Do not activate the `default` feature. |
| 17 | rust-analyzer.cargo.target (default: `null`):: | 17 | [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`):: |
| 18 | Compilation target (target triple). | 18 | Compilation target (target triple). |
| 19 | rust-analyzer.cargo.noSysroot (default: `false`):: | 19 | [[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`):: |
| 20 | Internal config for debugging, disables loading of sysroot crates. | 20 | Internal config for debugging, disables loading of sysroot crates. |
| 21 | rust-analyzer.checkOnSave.enable (default: `true`):: | 21 | [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`):: |
| 22 | Run specified `cargo check` command for diagnostics on save. | 22 | Run specified `cargo check` command for diagnostics on save. |
| 23 | rust-analyzer.checkOnSave.allFeatures (default: `null`):: | 23 | [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`):: |
| 24 | Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`. | 24 | Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`. |
| 25 | rust-analyzer.checkOnSave.allTargets (default: `true`):: | 25 | [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`):: |
| 26 | Check all targets and tests (will be passed as `--all-targets`). | 26 | Check all targets and tests (will be passed as `--all-targets`). |
| 27 | rust-analyzer.checkOnSave.command (default: `"check"`):: | 27 | [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`):: |
| 28 | Cargo command to use for `cargo check`. | 28 | Cargo command to use for `cargo check`. |
| 29 | rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`):: | 29 | [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`):: |
| 30 | Do not activate the `default` feature. | 30 | Do not activate the `default` feature. |
| 31 | rust-analyzer.checkOnSave.target (default: `null`):: | 31 | [[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`):: |
| 32 | Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`. | 32 | Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`. |
| 33 | rust-analyzer.checkOnSave.extraArgs (default: `[]`):: | 33 | [[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`):: |
| 34 | Extra arguments for `cargo check`. | 34 | Extra arguments for `cargo check`. |
| 35 | rust-analyzer.checkOnSave.features (default: `null`):: | 35 | [[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`):: |
| 36 | List of features to activate. Defaults to `#rust-analyzer.cargo.features#`. | 36 | List of features to activate. Defaults to `#rust-analyzer.cargo.features#`. |
| 37 | rust-analyzer.checkOnSave.overrideCommand (default: `null`):: | 37 | [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`):: |
| 38 | Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option. | 38 | Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option. |
| 39 | rust-analyzer.completion.addCallArgumentSnippets (default: `true`):: | 39 | [[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`):: |
| 40 | Whether to add argument snippets when completing functions. | 40 | Whether to add argument snippets when completing functions. |
| 41 | rust-analyzer.completion.addCallParenthesis (default: `true`):: | 41 | [[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`):: |
| 42 | Whether to add parenthesis when completing functions. | 42 | Whether to add parenthesis when completing functions. |
| 43 | rust-analyzer.completion.postfix.enable (default: `true`):: | 43 | [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`):: |
| 44 | Whether to show postfix snippets like `dbg`, `if`, `not`, etc. | 44 | Whether to show postfix snippets like `dbg`, `if`, `not`, etc. |
| 45 | rust-analyzer.completion.autoimport.enable (default: `true`):: | 45 | [[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`):: |
| 46 | Toggles the additional completions that automatically add imports when completed. Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled. | 46 | Toggles the additional completions that automatically add imports when completed. Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled. |
| 47 | rust-analyzer.diagnostics.enable (default: `true`):: | 47 | [[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`):: |
| 48 | Whether to show native rust-analyzer diagnostics. | 48 | Whether to show native rust-analyzer diagnostics. |
| 49 | rust-analyzer.diagnostics.enableExperimental (default: `true`):: | 49 | [[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`):: |
| 50 | Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual. | 50 | Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual. |
| 51 | rust-analyzer.diagnostics.disabled (default: `[]`):: | 51 | [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`):: |
| 52 | List of rust-analyzer diagnostics to disable. | 52 | List of rust-analyzer diagnostics to disable. |
| 53 | rust-analyzer.diagnostics.warningsAsHint (default: `[]`):: | 53 | [[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`):: |
| 54 | List of warnings that should be displayed with info severity.\n\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the `Problems Panel`. | 54 | List of warnings that should be displayed with info severity.\n\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the `Problems Panel`. |
| 55 | rust-analyzer.diagnostics.warningsAsInfo (default: `[]`):: | 55 | [[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`):: |
| 56 | List of warnings that should be displayed with hint severity.\n\nThe warnings will be indicated by faded text or three dots in code and will not show up in the `Problems Panel`. | 56 | List of warnings that should be displayed with hint severity.\n\nThe warnings will be indicated by faded text or three dots in code and will not show up in the `Problems Panel`. |
| 57 | rust-analyzer.files.watcher (default: `"client"`):: | 57 | [[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`):: |
| 58 | Controls file watching implementation. | 58 | Controls file watching implementation. |
| 59 | rust-analyzer.hoverActions.debug (default: `true`):: | 59 | [[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`):: |
| 60 | Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. | 60 | Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. |
| 61 | rust-analyzer.hoverActions.enable (default: `true`):: | 61 | [[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`):: |
| 62 | Whether to show HoverActions in Rust files. | 62 | Whether to show HoverActions in Rust files. |
| 63 | rust-analyzer.hoverActions.gotoTypeDef (default: `true`):: | 63 | [[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`):: |
| 64 | Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. | 64 | Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. |
| 65 | rust-analyzer.hoverActions.implementations (default: `true`):: | 65 | [[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`):: |
| 66 | Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. | 66 | Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. |
| 67 | rust-analyzer.hoverActions.run (default: `true`):: | 67 | [[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`):: |
| 68 | Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. | 68 | Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. |
| 69 | rust-analyzer.hoverActions.linksInHover (default: `true`):: | 69 | [[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`):: |
| 70 | Use markdown syntax for links in hover. | 70 | Use markdown syntax for links in hover. |
| 71 | rust-analyzer.inlayHints.chainingHints (default: `true`):: | 71 | [[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`):: |
| 72 | Whether to show inlay type hints for method chains. | 72 | Whether to show inlay type hints for method chains. |
| 73 | rust-analyzer.inlayHints.maxLength (default: `null`):: | 73 | [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`):: |
| 74 | Maximum length for inlay hints. Default is unlimited. | 74 | Maximum length for inlay hints. Default is unlimited. |
| 75 | rust-analyzer.inlayHints.parameterHints (default: `true`):: | 75 | [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`):: |
| 76 | Whether to show function parameter name inlay hints at the call site. | 76 | Whether to show function parameter name inlay hints at the call site. |
| 77 | rust-analyzer.inlayHints.typeHints (default: `true`):: | 77 | [[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`):: |
| 78 | Whether to show inlay type hints for variables. | 78 | Whether to show inlay type hints for variables. |
| 79 | rust-analyzer.lens.debug (default: `true`):: | 79 | [[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`):: |
| 80 | Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set. | 80 | Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set. |
| 81 | rust-analyzer.lens.enable (default: `true`):: | 81 | [[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`):: |
| 82 | Whether to show CodeLens in Rust files. | 82 | Whether to show CodeLens in Rust files. |
| 83 | rust-analyzer.lens.implementations (default: `true`):: | 83 | [[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`):: |
| 84 | Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set. | 84 | Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set. |
| 85 | rust-analyzer.lens.run (default: `true`):: | 85 | [[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`):: |
| 86 | Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set. | 86 | Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set. |
| 87 | rust-analyzer.lens.methodReferences (default: `false`):: | 87 | [[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`):: |
| 88 | Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set. | 88 | Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set. |
| 89 | rust-analyzer.linkedProjects (default: `[]`):: | 89 | [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`):: |
| 90 | Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format. | 90 | Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format. |
| 91 | rust-analyzer.lruCapacity (default: `null`):: | 91 | [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`):: |
| 92 | Number of syntax trees rust-analyzer keeps in memory. Defaults to 128. | 92 | Number of syntax trees rust-analyzer keeps in memory. Defaults to 128. |
| 93 | rust-analyzer.notifications.cargoTomlNotFound (default: `true`):: | 93 | [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`):: |
| 94 | Whether to show `can't find Cargo.toml` error message. | 94 | Whether to show `can't find Cargo.toml` error message. |
| 95 | rust-analyzer.procMacro.enable (default: `false`):: | 95 | [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`):: |
| 96 | Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be enabled. | 96 | Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be enabled. |
| 97 | rust-analyzer.runnables.overrideCargo (default: `null`):: | 97 | [[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`):: |
| 98 | Command to be executed instead of 'cargo' for runnables. | 98 | Command to be executed instead of 'cargo' for runnables. |
| 99 | rust-analyzer.runnables.cargoExtraArgs (default: `[]`):: | 99 | [[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`):: |
| 100 | Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`. | 100 | Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`. |
| 101 | rust-analyzer.rustcSource (default: `null`):: | 101 | [[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`):: |
| 102 | Path to the rust compiler sources, for usage in rustc_private projects. | 102 | Path to the rust compiler sources, for usage in rustc_private projects. |
| 103 | rust-analyzer.rustfmt.extraArgs (default: `[]`):: | 103 | [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`):: |
| 104 | Additional arguments to `rustfmt`. | 104 | Additional arguments to `rustfmt`. |
| 105 | rust-analyzer.rustfmt.overrideCommand (default: `null`):: | 105 | [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`):: |
| 106 | Advanced option, fully override the command rust-analyzer uses for formatting. | 106 | Advanced option, fully override the command rust-analyzer uses for formatting. |