Skip to content

Provide a more convinient way of developing rustc on NixOS #129620

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 17, 2024
Merged

Provide a more convinient way of developing rustc on NixOS #129620

merged 2 commits into from
Oct 17, 2024

Conversation

WaffleLapkin
Copy link
Member

@WaffleLapkin WaffleLapkin commented Aug 26, 2024 •
edited
Loading

This PR adds envrc files which, once symlinked as .envrc will activates a dev shell from src/tools/nix-dev-shell/flake.nix or src/tools/nix-dev-shell/shell.nix.

This is based on

This is something that I plan to use personally, but I thought it might be worth upstreaming :)

r? Noratrieb

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 26, 2024
@rust-log-analyzer

This comment has been minimized.

# to view
@Noratrieb
Copy link
Member

i feel like it makes more sense to just have a shell.nix and not a flake, to avoid having to update the lockfile and also because it's just simpler. i don't think we win much from having a flake

@Noratrieb Noratrieb added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 15, 2024
@WaffleLapkin
Copy link
Member Author

@Noratrieb I thought about it for a while, and I think I would still prefer this being a flake, simply for the purposes of stability. I've removed the lock file though (and .gitignored it), as updating it in-repo will just be useless churn.

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 20, 2024
@rust-log-analyzer

This comment has been minimized.

# to view
@Noratrieb
Copy link
Member

well, flakes are literally unstable :P

i think making everyone update their flake is annoying and I wouldn't want to use it myself - but the .envrc forces me to (I assume direnv has ways to work around this but it's still annoying). I'd be happy with having both a flake.nix and a shell.nix in the subdirectory, and also moving the .envrc there, so people can pick what they prefer (and the .envrc doesn't pollute the top level files even more)

@WaffleLapkin
Copy link
Member Author

I'd be happy with having both a flake.nix and a shell.nix in the subdirectory, and also moving the .envrc there, so people can pick what they prefer (and the .envrc doesn't pollute the top level files even more)

Done. I've added a nix-shell shell and two envrc files for flakes and nix-shell respectively, with the instruction on how to "enable" them.

Noratrieb
Noratrieb approved these changes Oct 17, 2024
View reviewed changes
Copy link
Member

@Noratrieb Noratrieb left a comment

Choose a reason for hiding this comment

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

sounds good, we can always patch it later if it's not good

@Noratrieb
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 17, 2024

📌 Commit 002a6b1 has been approved by Noratrieb

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 17, 2024
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 17, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 17, 2024
@bors
Auto merge of rust-lang#131848 - matthiaskrgr:rollup-l29a75j, r=matth…
3ed6e3c 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#129620 (Provide a more convinient way of developing rustc on NixOS)
 - rust-lang#131805 (rustc_llvm: Fix flattened CLI args)
 - rust-lang#131818 (Enable XRay instrumentation for LoongArch Linux targets)
 - rust-lang#131825 (SolverDelegate add assoc type for Infcx)
 - rust-lang#131833 (Add `must_use` to `CommandExt::exec`)
 - rust-lang#131835 (Do not run test where it cannot run)
 - rust-lang#131844 (Add mailmap entry for kobzol)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 7a7c313 into rust-lang:master Oct 17, 2024
6 checks passed
@rustbot rustbot added this to the 1.84.0 milestone Oct 17, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 17, 2024
@rust-timer
Unrolled build for rust-lang#129620
9c202ac 
Rollup merge of rust-lang#129620 - WaffleLapkin:flake, r=Noratrieb

Provide a more convinient way of developing rustc on NixOS

This PR adds envrc files which, once symlinked as  `.envrc` will activates a dev shell from `src/tools/nix-dev-shell/flake.nix` or `src/tools/nix-dev-shell/shell.nix`.

This is based on
- [Current rustc dev guide recommendation for NixOS](https://rustc-dev-guide.rust-lang.org/building/suggested.html?highlight=nix#using-nix-shell)
- https://github.com/oxalica/rust-overlay?tab=readme-ov-file#use-in-devshell-for-nix-develop
- [Nora's `x` nix package](https://github.com/Noratrieb/nixos/tree/26ea68e1a0aadaab313c1b5a8c1033a9770bd138/custom-pkgs/x)
- rust-lang/rustup#2891
- [Direnv: use flake/nix according to availability](https://discourse.nixos.org/t/direnv-use-flake-nix-according-to-availability/29825)

This is something that I plan to use personally, but I thought it might be worth upstreaming :)

r? Noratrieb
@WaffleLapkin WaffleLapkin deleted the flake branch October 17, 2024 22:29
@chiichen chiichen mentioned this pull request Jan 30, 2025
Merged
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@Noratrieb Noratrieb Noratrieb approved these changes

Assignees

@Noratrieb Noratrieb

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.84.0
Development

Successfully merging this pull request may close these issues.
5 participants
@WaffleLapkin @rust-log-analyzer @Noratrieb @bors @rustbot