Skip to content

Update README.md #20114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #20114

wants to merge 2 commits into from

Conversation

jmikedupont2
Copy link

please mention at top level dir

please mention at top level dir
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 28, 2025
cargo run -p xtask -- install --server rust-lang#20141
@ShoyuVanilla
Copy link
Member

Well, I don't think we should inform this in README. The binary that installed with cargo xtask is not for "retails":

fn install_server(sh: &Shell, opts: ServerOpt) -> anyhow::Result<()> {
let features = opts.malloc.to_features();
let profile = if opts.dev_rel { "dev-rel" } else { "release" };
let mut install_cmd = cmd!(
sh,
"cargo install --path crates/rust-analyzer --profile={profile} --locked --force --features force-always-assert {features...}"
);

That enables force-always-assert, which turns on panicking on many internal assertions that just leaving error logs in our "retail" build. So, this might cause irritating panics to uses, so we cannot recommend that by default.
Also, the manual page already contains various ways to install rust-analyzer and it's not hidden so deep inside the nested chapters, so I think current manual page link is enough

@lnicola
Copy link
Member

lnicola commented Jul 10, 2025

Agreed, let's link to https://rust-analyzer.github.io/book/rust_analyzer_binary.html instead (even though there's another link to the manual right above, maybe change that to https://rust-analyzer.github.io/book/installation.html.

And the force-always-assert thing isn't actually documented in the manual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants