about summary refs log tree commit diff
path: root/src/tools/rust-analyzer/docs/user/manual.adoc
AgeCommit message (Collapse)AuthorLines
2025-01-24manual: Convert to mdbookWilfred Hughes-1121/+0
Split manual.adoc into markdown files, one for each chapter. For the parts of the manual that are generated from source code doc comments, update the comments to use markdown syntax and update the code generators to write to `generated.md` files. For the weekly release, stop copying the .adoc files to the `rust-analyzer/rust-analyzer.github.io` at release time. Instead, we'll sync the manual hourly from this repository. See https://github.com/rust-analyzer/rust-analyzer.github.io/pull/226 for the sync. This PR should be merged first, and that PR needs to be merged before the next weekly release. This change is based on #15795, but rebased and updated. I've also manually checked each page for markdown syntax issues and fixed any I encountered. Co-authored-by: Lukas Wirth <lukastw97@gmail.com> Co-authored-by: Josh Rotenberg <joshrotenberg@gmail.com>
2025-01-21manual: Document all rust-project.json fieldsWilfred Hughes-7/+83
Ensure that all the fields that rust-analyzer understands are in the manual, they all have doc comments, and they use consistent punctuation (`;` rather than mixing `,` and `;`). Whilst we're here, fix the `sysroot_src` example and add 2024 as a legal value for Rust edition.
2025-01-07target-triple -> target-tupleLukas Wirth-1/+1
2024-12-11Fix publish workflow link in manualSam Estep-1/+1
2024-08-12Allow declaring cfg groups in rust-project.json, to help sharing common cfgsChayim Refael Friedman-0/+12
2024-08-05add msvc note to manualJoel Daniel Rico-0/+6
2024-07-14Update manual.adocAnita Hammer-1/+1
2024-06-19Auto merge of #17438 - jjoeldaniel:toggle_lsp_logs, r=Veykrilbors-1/+1
feat: add `toggleLSPLogs` command Implement client-side command to toggle LSP logs in VSCode. The command replaces the need to add/remove the `"rust-analyzer.trace.server": "verbose"` setting each time one wants to display logs. I've also updated the docs/ instances that reference the now outdated manual method. The command labeled `rust-analyzer: Toggle LSP Logs` enables the setting project-wide and opens the relevant trace output channel. Closes #8233
2024-06-17feat: add `toggleLSPLogs` commandJoel Daniel Rico-1/+1
add `toggleLSPLogs` command update docs to reflect new command
2024-06-16docs: fix manual generation instructionsLunaphied-1/+1
To generate all the requisite files, you need to run `cargo xtask codegen` not `cargo test -p xtask`.
2024-05-17Correct Neovim 0.10 inlay hints config exampleAdam Szkoda-1/+1
2024-04-26manual: remove suggestion of rust-project.json exampleCliff L. Biffle-2/+0
The manual has been linking to the repo https://github.com/rust-analyzer/rust-project.json-example/tree/master This repo does not contain a rust-project.json, does not appear to have _ever_ contained a rust-project.json, and my bug report about this has gone untouched: https://github.com/rust-analyzer/rust-project.json-example/issues/4 Since I can't figure out an example, this commit removes the link pending better documentation.
2024-04-21Allow rust files to be used linkedProjectsLukas Wirth-0/+1029