Skip to content

Commit

Permalink
Document that -p shotover-proxy should be used when building for sh…
Browse files Browse the repository at this point in the history
…ipping (#1748)
  • Loading branch information
rukai authored Sep 10, 2024
1 parent 1bae971 commit e72e945
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/src/dev-docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ So check what its doing in `.github/workflows/lint.yaml` if you have a failure i

### Building Shotover (release)

To build a release binary of shotover run `cargo build --release`.
The built binary is located at `target/release/shotover-proxy`.
The `--release` is very important, never deploy a non-release binary as it will be far too slow.
To build a release binary of shotover run `cargo build --release -p shotover-proxy`:

* The built binary is located at `target/release/shotover-proxy`
* The `--release` is very important, never deploy a non-release binary as it will be far too slow.
* The `-p shotover-proxy` is optional but skips building artifacts only used during development.
Doing this is much faster to build and avoids extra external dependencies.

0 comments on commit e72e945

Please sign in to comment.