about summary refs log tree commit diff
path: root/docs/user
AgeCommit message (Collapse)AuthorLines
2021-03-22Update docs/user/manual.adocAleksey Kladov-1/+1
Co-authored-by: bjorn3 <bjorn3@users.noreply.github.com>
2021-03-22Document our security stanceAleksey Kladov-0/+14
changelog: feature
2021-03-18Update docs/user/manual.adocAleksey Kladov-1/+1
2021-03-18Update info about Eclipse CorrosionMickael Istria-4/+2
2021-03-15Enable proc-macros by defaultAleksey Kladov-1/+1
2021-03-12Fix remaining references to `cargo xtask codegen`Lukas Wirth-1/+1
2021-03-09Make code less surprisingAleksey Kladov-57/+265
Theres no reason to have literal `\n\n` in the source code
2021-03-08Add more documentation for rustc_privateJoshua Nelson-1/+1
2021-03-08Merge #7891bors[bot]-1/+1
7891: Improve handling of rustc_private r=matklad a=DJMcNab This PR changes how `rust-analyzer` handles `rustc_private`. In particular, packages now must opt-in to using `rustc_private` in `Cargo.toml`, by adding: ```toml [package.metadata.rust-analyzer] rustc_private=true ``` This means that depending on crates which also use `rustc_private` will be significantly improved, since their dependencies on the `rustc_private` crates will be resolved properly. A similar approach could be used in #6714 to allow annotating that your package uses the `test` crate, although I have not yet handled that in this PR. Additionally, we now only index the crates which are transitive dependencies of `rustc_driver` in the `rustcSource` directory. This should not cause any change in behaviour when using `rustcSource: "discover"`, as the source used then will only be a partial clone. However, if `rustcSource` pointing at a local checkout of rustc, this should significantly improve the memory usage and lower indexing time. This is because we avoids indexing all crates in `src/tools/`, which includes `rust-analyzer` itself. Furthermore, we also prefer named dependencies over dependencies from `rustcSource`. This ensures that feature resolution for crates which are depended on by both `rustc` and your crate uses the correct set for analysing your crate. See also [introductory zulip stream](https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0/topic/Fixed.20crate.20graphs.20and.20optional.20builtin.20crates/near/229086673) I have tested this in [priroda](https://github.com/oli-obk/priroda/), and it provides a significant improvement to the development experience (once I give `miri` the required data in `Cargo.toml`) Todo: - [ ] Documentation This is ready to review, and I will add documentation if this would be accepted (or if I get time to do so anyway) Co-authored-by: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
2021-03-08Document rustc_private in metadataDaniel McNab-1/+1
2021-03-08Revert "Support disabling rustc build scripts"Daniel McNab-2/+0
This reverts commit ddce6bb282764692d53b719bff4c37e3512d4556.
2021-03-08Make code completion "just work" in more casesAleksey Kladov-1/+1
2021-03-08Support disabling rustc build scriptsDaniel McNab-0/+2
2021-03-07Merge #7889bors[bot]-0/+2
7889: Make group imports configurable r=lnicola a=asv1 Co-authored-by: asv <asv7c2@gmail.com>
2021-03-07Make group imports configurableasv-0/+2
2021-03-06Add a line about code action commands to the CoC section of the docsFlorian Diebold-0/+2
2021-03-04Migrate to user-centric config name for `cargo check` stuffAleksey Kladov-3/+3
2021-02-24Fix typo.boxdot-1/+1
2021-02-13Allow automatically detect the rustc-src directory (fixes #3517).Benjamin Bouvier-1/+1
If the configured rustcSource is set to "discover", try to automatically detect a source from the sysroot rustc directory.
2021-02-08Add emacs guideAleksey Kladov-0/+2
2021-02-08Merge #7592bors[bot]-0/+10
7592: [Doc] Note about Eclipse IDE support r=lnicola a=mickaelistria Co-authored-by: Mickael Istria <mistria@redhat.com>
2021-02-08[Doc] Note about Eclipse IDE supportMickael Istria-0/+10
2021-02-07Vim docs: vim-lsp with initial configuration.Ilya Bobyr-0/+46
`vim-lsp` is another popular LSP client for Vim. And, as there is no `rust-analyzer` specific UI, it is non-trivial to figure out how the initial configuration is performed.
2021-02-07Explain how initial configuration is sent over LSP.Ilya Bobyr-5/+27
2021-02-01Improve nvim-lsp setup instructionsLaurențiu Nicola-1/+34
2021-01-26Add config option to ignore directoriesAleksey Kladov-0/+2
2021-01-26Remove the need to manually sync config in package.jsonAleksey Kladov-4/+4
2021-01-23Add References code lens.vsrs-0/+2
For Struct, Enum, Union and Trait symbols.
2021-01-07Merge #7195bors[bot]-2/+2
7195: Update remaining serverPath references r=lnicola a=lnicola Fixes https://github.com/rust-analyzer/rust-analyzer/pull/7156#issuecomment-755487667 Co-authored-by: Laurențiu Nicola <lnicola@dend.ro>
2021-01-07Update remaining serverPath referencesLaurențiu Nicola-2/+2
2021-01-07Use american spelling for configAleksey Kladov-1/+1
As per https://github.com/rust-analyzer/rust-analyzer/blob/171c3c08fe245938fb25321394233de5fe2abc7c/docs/dev/style.md#variable-naming Also implement config aliasing, for pain-free settings migrations in the future
2021-01-06More maintainable configAleksey Kladov-0/+2
Rather than eagerly converting JSON, we losslessly keep it as is, and change the shape of user-submitted data at the last moment. This also allows us to remove a bunch of wrong Defaults
2021-01-05Allow `#anchor` linking of config optionsAleksey Kladov-53/+53
2021-01-03Merge #7113bors[bot]-0/+3
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 <tekul.hs@gmail.com>
2021-01-01Add support for Rust 2021.Mara Bos-1/+1
2020-12-31Expand contributing "tip" in manual.adocLuke Taylor-0/+3
- 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
2020-12-24Update manual.adocHeyward Fann-1/+1
2020-12-23Document, how to view config in effectAleksey Kladov-0/+3
2020-12-22Clean up descriptions for settingsRüdiger Herrmann-13/+13
Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-20Split lines between sentencesLaurențiu Nicola-15/+27
2020-12-20Document the version requirements for building from sourceLaurențiu Nicola-1/+1
2020-12-14Link config sourceAleksey Kladov-0/+2
2020-12-13Docs: Explain manual installation in VS CodeChristian Authmann-0/+17
2020-12-11Use natural trait ordering in derive completionAleksey Kladov-119/+0
derive(Clone, Copy) reads better than derive(Copy, Clone). However, we preserve the reverse ordering in the lookup text for sorting purposes. That way, it's convenient to type just `Ord` to derive everything.
2020-12-10Improve docs for building from sourceLaurențiu Nicola-1/+8
2020-12-09Fix a typo in manual.adocJosh Stone-1/+1
2020-12-09Include config into the manualAleksey Kladov-0/+115
2020-11-27More accurately place proc-macro diagnosticJonas Schievink-1/+1
2020-11-27Publish diagnostics for macro expansion errorsJonas Schievink-0/+14
2020-10-29docs: Update Neovim nvim-lspconfig repository linkDave Lage-2/+2