Skip to content

Commit 1dee824

Browse files
authored
doc: add notes for .cargo/config.toml (risingwavelabs#8632)
1 parent 13641c8 commit 1dee824

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/developer-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ RiseDev is the development mode of RisingWave. To develop RisingWave, you need t
7272
* OpenSSL
7373
* PostgreSQL (psql) (>= 14.1)
7474
* Tmux (>= v3.2a)
75-
* LLVM 15 (To workaround some bugs in macOS toolchain, see https://github.com/risingwavelabs/risingwave/issues/6205).
75+
* LLVM 15 (For macOS only, to workaround some bugs in macOS toolchain. See https://github.com/risingwavelabs/risingwave/issues/6205).
7676

7777
To install the dependencies on macOS, run:
7878

@@ -90,6 +90,10 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
9090

9191
Then you'll be able to compile and start RiseDev!
9292

93+
> **Note**
94+
>
95+
> `.cargo/config.toml` contains `rustflags` configurations like `-Clink-arg` and `-Ctarget-feature`. Since it will be [merged](https://doc.rust-lang.org/cargo/reference/config.html#hierarchical-structure) with `$HOME/.cargo/config.toml`, check the config files and make sure they don't conflict if you have global `rustflags` configurations for e.g. linker there.
96+
9397
## Start and monitor a dev cluster
9498

9599
You can now build RiseDev and start a dev cluster. It is as simple as:

0 commit comments

Comments
 (0)