about summary refs log tree commit diff
path: root/src/tools/rust-analyzer/docs/book
AgeCommit message (Collapse)AuthorLines
2025-09-22Clarify `rust-analyzer.inlayHints.maxLength` is not a hard guaranteeChayim Refael Friedman-0/+2
2025-09-17Merge pull request #20583 from btj/comments-enableChayim Refael Friedman-0/+11
Add `rust-analyzer.semanticHighlighting.comments.enable`
2025-09-17Add the `rust-analyzer.semanticHighlighting.comments.enable` configuration valueBart Jacobs-0/+11
2025-09-15Add a testing guideChayim Refael Friedman-0/+107
2025-09-09Add a FAQ entry about RA and Cargo interactionJakub Beránek-0/+9
2025-09-09Update documentation about how to build the RA bookJakub Beránek-0/+1
2025-09-08Clarify intro in README and manualWilfred Hughes-7/+14
The first sentence a new user should see should ideally answer the questions: * What is rust-analyzer? * Why might I want to use it? The vast majority of users will be interested in using rust-analyzer inside their favourite editor. We should clarify that rust-analyzer is an LSP implementation and that it supports all the classic IDE features. Whilst it's also true that rust-analyzer is modular and organised into libraries, the first impression should (I think) focus on an overview and the primary use case.
2025-08-26Merge pull request #20520 from ChayimFriedman2/reborrowShoyu Vanilla (Flint)-0/+11
feat: Add an option to remove reborrows from adjustment inlay hints
2025-08-24Fix rust-analyzer-contributors referenceEmmanuel Ferdman-1/+1
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
2025-08-24Add an option to remove reborrows from adjustment inlay hintsChayim Refael Friedman-0/+11
Reborrows are consecutive deref then ref. Make it the default because reborrows are mostly useless to the programmer. Also rename `rust-analyzer.inlayHints.expressionAdjustmentHints.enable: "reborrow"` to `rust-analyzer.inlayHints.expressionAdjustmentHints.enable: "borrows"`, as it's not about reborrows but about any ref/deref and it's confusing with the new setting.
2025-08-13Fix dead link to Cargo.toml in documentationdonni-h-1/+1
../../Cargo.toml resolves to https://rust-analyzer.github.io/Cargo.toml, which is an invalid link
2025-08-10Add config option to exclude locals from doc searchIfeanyi Orizu-0/+7
2025-08-01Fix more docsIfeanyi Orizu-6/+8
2025-08-01Update documentation for overrideCommand config optionsIfeanyi Orizu-2/+9
2025-07-29Merge pull request #20154 from joshka/jm/improve-setting-titlesLukas Wirth-133/+159
Improve settings tree title and descriptions
2025-07-22Apply suggestions from code reviewJakub Beránek-4/+5
Co-authored-by: Laurențiu Nicola <lnicola@users.noreply.github.com>
2025-07-22Document synces using `josh-sync`Jakub Beránek-12/+41
2025-07-04remove syntaxTree from docsvinícius x-18/+0
2025-07-02Improve settings tree title and descriptionsJosh McKinney-133/+159
- All settings are now phrased in the imperative form stating what the setting does rather than talking about what it controls. (E.g.: "Show `Debug` action." instead of "Whether to show `Debug` action" - Categories are now displayed in title case - Categories are now sorted lexicographically - General category is removed (and all the settings are moved to the top level) - Language for a few descriptions is made a bit less ambiguous
2025-06-26refactor: rename `branches` to `branch_exit_points` in highlight_relatedroifewu-1/+1
2025-06-26feat: highlighting of related return values while the cursor is on any ↵roifewu-0/+7
`match`, `if`, or match arm arrow (`=>`)
2025-06-25Fix link in the bookChayim Refael Friedman-3/+2
2025-06-24Merge pull request #20064 from Wilfred/document_sysroot_projectLukas Wirth-0/+3
Document sysroot_project field in rust-project.json
2025-06-23Add troubleshooting FAQ to the bookChayim Refael Friedman-0/+12
And one frequently asked question.
2025-06-23Document sysroot_project field in rust-project.jsonWilfred Hughes-0/+3
2025-06-20Add better documentation for excluding imports from symbol searchLucas Holten-1/+5
2025-06-19fix: Temporarily disable `+` typing handler as it moves the cursor positionLukas Wirth-1/+1
2025-06-17Merge pull request #19939 from ChayimFriedman2/fill-arms-selfLukas Wirth-0/+7
feat: In "Fill match arms", allow users to prefer `Self` to the enum name when possible
2025-06-16feat: Insert required parentheses when typing `+` in trait typeLukas Wirth-1/+1
2025-06-16Merge pull request #19994 from sourcefrog/book-linksLaurențiu Nicola-3/+2
Fix some links in the book
2025-06-15Add config option to exclude imports from symbol searchLucas Holten-0/+7
2025-06-13Make the URL a hyperlinkMartin Pool-1/+1
2025-06-13Fix link to the contribution guideMartin Pool-2/+1
2025-06-13Fix link to good first issuesJakub Beránek-1/+1
2025-06-10[minor] Fix typosWilfred Hughes-1/+1
2025-06-06In "Fill match arms", allow users to prefer `Self` to the enum name when ↵Chayim Refael Friedman-0/+7
possible But default to not to. I chose to have a more generic config name because maybe other assists could also use the same approach.
2025-06-02internal: Use 'ProjectJson' consistentlyWilfred Hughes-1/+1
The Rust source code previously mised ProjectJson and JsonProject, and the TypeScript definition didn't match either. Use 'ProjectJson' everywhere. This is purely an internal change.
2025-05-28feat: Render padding information when hovering on structsShoyu Vanilla-0/+7
2025-05-26Merge pull request #19819 from Veykril/push-utvzwvwuuvlmLukas Wirth-1/+1
Change import prefix default to be by crate
2025-05-22Remove rust-analyzer.vs from other editorsOli Scherer-24/+0
2025-05-19Change import prefix default to be by crateLukas Wirth-1/+1
The current default plain, tends to create non-uniform import blocks over time, some being relative, some being absolute. I believe we should encourage a different default here.
2025-04-20doc: Fix dead manual linksbbb651-1/+1
2025-04-20doc: Rework generated configuration to have anchorsbbb651-353/+681
Also first line of default code blocks being used as the language instead of json and fixes a missing `json` language in a doc comment code block.
2025-04-09internal: rename `children_modules` to `child_modules`David Barsky-1/+1
2025-04-07cargo xtask tidygeetanshjuneja-1/+1
2025-04-04feat(project-model): provide flag for no depsPrajwal S N-0/+6
A Cargo project can now be built without any dependency metadata being fetched. Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
2025-03-24chore: Cleanup vscode extension output channelsLukas Wirth-3/+6
2025-03-22Improve contributing/README.mdBenjaminBrienen-8/+8
2025-03-15cargo xtask tidyBenjaminBrienen-1/+1
2025-03-15edition = "2024"BenjaminBrienen-1/+1