Skip to content

Commit f66833f

Browse files
committed
revert: remove rust-toolchain
We use nix-shell to define the default version of rust (stable). If people wish to "bring their own" they can use `--arg norust true` or use `.envrc`. Having a default rust-toolchain in the repo prevents this previous behaviour from working correctly. And would require making changes to the repo if one wants to override it. I've updated the docs to reflect this.
1 parent 0f336ae commit f66833f

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

doc/build.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ you won't need to worry about cross compiler toolchains, and all builds are repr
1818

1919
## Prerequisites
2020

21-
Mayastor **only** builds on modern Linuxes. We'd adore contributions to add support for
21+
Mayastor **only** builds on modern Linuxes. We'd adore contributions to add support for
2222
Windows, FreeBSD, OpenWRT, or other server platforms.
2323

2424
If you do not have Linux system:
@@ -28,7 +28,7 @@ If you do not have Linux system:
2828
* **Mac:** We recommend you use [Docker for Mac][docker-install]
2929
and follow the Docker process described. Please let us know if you find a way to
3030
run it!
31-
* **FreeBSD:** We *think* this might actually work, SPDK is compatible! But, we haven't
31+
* **FreeBSD:** We *think* this might actually work, SPDK is compatible! But, we haven't
3232
tried it yet.
3333
* **Others:** This is kind of a "Do-it-yourself" situation. Sorry, we can't be more help!
3434

@@ -43,7 +43,7 @@ curl -L https://nixos.org/nix/install | sh
4343
> **Can't install Nix?**
4444
>
4545
> That's totally fine. You can use [`docker`][docker-install] just fine for one-off or occasional PRs!
46-
>
46+
>
4747
> This flow will get you a pre-fetched `nix` store:
4848
> ```bash
4949
> docker run --name mayastor-nix-prefetch -it -v $(pwd):/scratch:rw --privileged --workdir /scratch nixos/nix nix-shell --run "exit 0"
@@ -75,16 +75,16 @@ First, setting the following:
7575
Then, updating the channel:
7676
7777
```bash
78-
$ sudo nix-channel --list
78+
$ sudo nix-channel --list
7979
nixos https://nixos.org/channels/nixos-20.09
8080
$ sudo nix-channel --remove nixos
8181
$ sudo nix-channel --add https://nixos.org/channels/nixos-unstable nixos
8282
$ sudo nixos-rebuild switch --update
8383
```
8484
85-
> If you don't want, you can drop into a
85+
> If you don't want, you can drop into a
8686
`nixUnstable` supporting shell with:
87-
>
87+
>
8888
> ```bash
8989
> nix-shell -I nixpkgs=channel:nixpkgs-unstable -p nixUnstable --command "nix --experimental-features 'nix-command flakes' develop -f . mayastor"
9090
> ```
@@ -96,7 +96,7 @@ $ sudo nixos-rebuild switch --update
9696
9797
9898
You can use a tool like [`direnv`][direnv] to automate `nix shell` entry.
99-
99+
If you are unable to use the Nix provided Rust for some reason, there are `norust` and `nospdk` arguments to Nix shell. `nix-shell --arg norust true`
100100
## Iterative Builds
101101
102102
Contributors often build Mayastor repeatedly during the development process.
@@ -120,6 +120,8 @@ cargo build --release
120120
**Want to run or hack on Mayastor?** *You need more configuration!* See
121121
[running][doc-running], then [testing][doc-testing].
122122
123+
To ensure you are aware of this, we greet you with a nice cow.
124+
123125
## Artifacts
124126
125127
There are a few ways to build Mayastor! If you're hacking on Mayastor, it's best to use

rust-toolchain

-1
This file was deleted.

0 commit comments

Comments
 (0)