@@ -18,7 +18,7 @@ you won't need to worry about cross compiler toolchains, and all builds are repr
18
18
19
19
## Prerequisites
20
20
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
22
22
Windows, FreeBSD, OpenWRT, or other server platforms.
23
23
24
24
If you do not have Linux system:
@@ -28,7 +28,7 @@ If you do not have Linux system:
28
28
* ** Mac:** We recommend you use [ Docker for Mac] [ docker-install ]
29
29
and follow the Docker process described. Please let us know if you find a way to
30
30
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
32
32
tried it yet.
33
33
* ** Others:** This is kind of a "Do-it-yourself" situation. Sorry, we can't be more help!
34
34
@@ -43,7 +43,7 @@ curl -L https://nixos.org/nix/install | sh
43
43
> ** Can't install Nix?**
44
44
>
45
45
> That's totally fine. You can use [ ` docker ` ] [ docker-install ] just fine for one-off or occasional PRs!
46
- >
46
+ >
47
47
> This flow will get you a pre-fetched ` nix ` store:
48
48
> ``` bash
49
49
> 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:
75
75
Then, updating the channel:
76
76
77
77
` ` ` bash
78
- $ sudo nix-channel --list
78
+ $ sudo nix-channel --list
79
79
nixos https://nixos.org/channels/nixos-20.09
80
80
$ sudo nix-channel --remove nixos
81
81
$ sudo nix-channel --add https://nixos.org/channels/nixos-unstable nixos
82
82
$ sudo nixos-rebuild switch --update
83
83
` ` `
84
84
85
- > If you don' t want, you can drop into a
85
+ > If you don' t want, you can drop into a
86
86
`nixUnstable` supporting shell with:
87
- >
87
+ >
88
88
> ```bash
89
89
> nix-shell -I nixpkgs=channel:nixpkgs-unstable -p nixUnstable --command "nix --experimental-features ' nix-command flakes' develop -f . mayastor"
90
90
> ```
@@ -96,7 +96,7 @@ $ sudo nixos-rebuild switch --update
96
96
97
97
98
98
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`
100
100
## Iterative Builds
101
101
102
102
Contributors often build Mayastor repeatedly during the development process.
@@ -120,6 +120,8 @@ cargo build --release
120
120
**Want to run or hack on Mayastor?** *You need more configuration!* See
121
121
[running][doc-running], then [testing][doc-testing].
122
122
123
+ To ensure you are aware of this, we greet you with a nice cow.
124
+
123
125
## Artifacts
124
126
125
127
There are a few ways to build Mayastor! If you' re hacking on Mayastor, it' s best to use
0 commit comments