Skip to content

Conversation

clubby789
Copy link
Contributor

rust-lang/rust#107757 moves the recommended settings.json setup into x.py setup, so update the dev guide accordingly.

cc @jyn514

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks! I would like to wait until the rust-lang/rust PR merges before merging this but otherwise LGTM :)

@jyn514 jyn514 merged commit ed5b175 into rust-lang:master Feb 8, 2023
@RalfJung
Copy link
Member

RalfJung commented Feb 9, 2023

I think this is unfortunate; having the file content available on a website made it much easier to update the file when changes are required (which happens fairly regularly, 1-2 times a year): when things behave strangely, I would just go to https://rustc-dev-guide.rust-lang.org/building/suggested.html#configuring-rust-analyzer-for-rustc and see what is different from my config.

Doing ./x.py setup instead doesn't work, it asks me a question instead of just printing the desired vscode settings:

Welcome to the Rust project! What do you want to do with x.py? a) library: Contribute to the standard library b) compiler: Contribute to the compiler itself c) codegen: Contribute to the compiler, and also modify LLVM or codegen d) tools: Contribute to tools which depend on the compiler, but do not modify it directly (e.g. rustdoc, clippy, miri) e) user: Install Rust from source Please choose one (a/b/c/d/e): 

The correct answer for me is "a, b, c, d". 😂 Also my config.toml already works for all of these cases, I don't want it to be changed please. (Nor do I have any idea what the various answers would do -- so there's a perceived risk that just picking something breaks stuff for me. Giving me a choice without telling me about its consequences does not feel great.)

How can I get the recommended vscode settings without having the tool change my config.toml?

@jyn514
Copy link
Member

jyn514 commented Feb 9, 2023

@RalfJung you can run cp src/etc/vscode_settings.json .VSCode/settings.json. I'm happy to make a note of that in the docs, are you interested in making a PR with that change? ;)

Separately, setup is doing enough things now that I think allowing things like setup hook and setup vscode makes sense so you don't have to go through the whole flow.

@RalfJung
Copy link
Member

RalfJung commented Feb 9, 2023

you can run cp src/etc/vscode_settings.json .VSCode/settings.json

No that won't work, my settings.json contains a bunch of custom stuff as well.

Maybe the wiki page could just link to https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json ?

@jyn514
Copy link
Member

jyn514 commented Feb 9, 2023

Maybe the wiki page could just link to https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json ?

👍 seems good - we do that already for the nvim paragraph but it's not rendered so it's not obvious.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 13, 2023
Update books ## rust-lang/book 2 commits in f2a78f64b668f63f581203c6bac509903f7c00ee..d94e03a18a2590ed3f1c67b859cb11528d2a2d5c 2023-02-10 16:01:09 UTC to 2023-02-10 15:55:43 UTC - Update to Rust 1.67.1 - Update to Rust 1.66.1 ## rust-embedded/book 1 commits in f1a4614aa41cc544b91b79760a709e113f3451d7..701d1551429da4cb609082c0ac99df569e336710 2023-01-31 12:32:49 UTC to 2023-01-31 12:32:49 UTC - fix: Circled Image not visible on B&W E-Ink screen (rust-embedded/book#339) ## rust-lang/nomicon 2 commits in bd1829d235296952bf72ca55635e360584b8805e..79b53665a7c61d171fb8c5ad0b73b371f9ee6ba7 2023-02-13 08:40:24 UTC to 2023-02-07 09:43:03 UTC - Fixes double bug in Send-Sync example (rust-lang/nomicon#401) - Small language fix in subtyping.md (rust-lang/nomicon#399) ## rust-lang/reference 4 commits in 22882fb3f7b4d69fdc0d1731e8b9cfcb6910537d..e5adb99c04817b7fbe08f4ffce5b36702667345f 2023-02-08 18:09:03 UTC to 2023-02-01 03:49:46 UTC - Eliminate 'half open' terminology from range pattern grammar (rust-lang/reference#1330) - fix place expression context example (rust-lang/reference#1327) - remove confusing words (rust-lang/reference#1324) - Reword "expression for a match arm" (rust-lang/reference#1325) ## rust-lang/rust-by-example 5 commits in 134376872e8c387ef369507e0ee9b5a0e3272718..efe23c4fe12e06351b8dc8c3d18312c761455109 2023-02-06 11:32:23 UTC to 2023-01-31 16:38:03 UTC - fix irrelevant comments (rust-lang/rust-by-example#1676) - remove redudant code (rust-lang/rust-by-example#1675) - Line comments: change 'inside' to 'after' (rust-lang/rust-by-example#1674) - fix incorrect trait bound demonstration (rust-lang/rust-by-example#1673) - fix "High Order Functions" typo (rust-lang/rust-by-example#1672) ## rust-lang/rustc-dev-guide 14 commits in e359ee2..41a96ab 2023-02-11 06:41:56 UTC to 2023-01-31 18:42:30 UTC - Add a citation file (rust-lang/rustc-dev-guide#1550) - Improve git submodule help (rust-lang/rustc-dev-guide#1587) - update examples for rustc 1.69.0-nightly (e1eaa2d 2023-02-06) (rust-lang/rustc-dev-guide#1590) - Replace settings.json with x.py setup note (rust-lang/rustc-dev-guide#1588) - Do not add accept header on linkcheck (rust-lang/rustc-dev-guide#1586) - Fixed small grammar mistake in monomorph.md (rust-lang/rustc-dev-guide#1585) - update bootstrap guide (rust-lang/rustc-dev-guide#1583) - Use host symlink for custom rustup toolchain (rust-lang/rustc-dev-guide#1580) - Fix broken links (rust-lang/rustc-dev-guide#1577) - Add section on comparing types (rust-lang/rustc-dev-guide#1570) - Update rustfmt path (rust-lang/rustc-dev-guide#1574) - fix wrong heading level (rust-lang/rustc-dev-guide#1573) - fix incorrect position of `Clarification of build command's stdout` (rust-lang/rustc-dev-guide#1572) - extend bootstrap related documentations (rust-lang/rustc-dev-guide#1563)
Kobzol pushed a commit to Kobzol/rustc-dev-guide that referenced this pull request Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants