Skip to content

Commit f2a95d7

Browse files
robertoaloimeta-codesync[bot]
authored andcommitted
Recommend release-thin profile for development
Summary: Add tip for ELP developers, to avoid slow compilation times during develoment. Reviewed By: jcpetruzza Differential Revision: D85240198 fbshipit-source-id: 93db3cc8646ff3d954fb2fe7af33963755727274
1 parent 5fe7e93 commit f2a95d7

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

website/docs/get-started/install.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,25 +67,38 @@ sbt assembly
6767
popd
6868
```
6969

70-
Point the `ELP_EQWALIZER_PATH` environment variable to the path of the produced `eqwalizer.jar` file:
70+
Point the `ELP_EQWALIZER_PATH` environment variable to the path of the produced
71+
`eqwalizer.jar` file:
7172

7273
```
7374
export ELP_EQWALIZER_PATH=$(find "$(pwd)" -name eqwalizer.jar)
7475
```
7576

76-
Point the `EQWALIZER_DIR` environment variable to the path of the `eqwalizer_support` directory:
77+
Point the `EQWALIZER_DIR` environment variable to the path of the
78+
`eqwalizer_support` directory:
7779

7880
```
7981
export EQWALIZER_DIR=$(find "$(pwd)" -name eqwalizer_support)
8082
```
8183

8284
Now we can compile ELP:
8385

86+
:::tip
87+
88+
The commands below will produce a release build, which has the best runtime
89+
performance, at the price of a slower compilation time. If you are developing
90+
ELP, consider using `cargo build --profile release-thin`, as it provides a much
91+
faster development loop while still producing a performant binary. You will find
92+
the corresponding binary in `target/release-thin/elp`.
93+
94+
:::
95+
8496
```
8597
cargo build --release
8698
```
8799

88-
The produced executable will be available in: `target/release/elp`, so ensure it is included in your `PATH`. E.g.:
100+
The produced executable will be available in: `target/release/elp`, so ensure it
101+
is included in your `PATH`. E.g.:
89102

90103
```
91104
mkdir -p ~/bin

0 commit comments

Comments
 (0)