Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike Gerwitz <mike.gerwitz@ryansg.com>2019-11-27 09:17:27 -0500
committerMike Gerwitz <mike.gerwitz@ryansg.com>2019-12-02 10:00:49 -0500
commite53482f2a3af95338acded5a6a5b970c879e88c5 (patch)
treeea43df3e902e39248e00b207101e1dcd5afc34a9 /tamer/README.md
parentd96f090337d2510de2668b733d8a17746f267eb1 (diff)
downloadtame-e53482f2a3af95338acded5a6a5b970c879e88c5.tar.gz
tame-e53482f2a3af95338acded5a6a5b970c879e88c5.tar.bz2
tame-e53482f2a3af95338acded5a6a5b970c879e88c5.zip
Introduce CARGO_BUILD_FLAGS
This is intended to permit passing `--release`, since dev builds are terribly slow (e.g. 6s -> 0.2s). See README.md for more information.
Diffstat (limited to 'tamer/README.md')
-rw-r--r--tamer/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/tamer/README.md b/tamer/README.md
index 686f2ff..6d44f02 100644
--- a/tamer/README.md
+++ b/tamer/README.md
@@ -24,3 +24,26 @@ To bootstrap from the source repository, run `./bootstrap`.
To configure the build for your system, run `./configure`. To build, run
`make`. To run tests, run `make check`.
+You may also invoke `cargo` directly, which `make` will do for you using
+options provided to `configure`.
+
+*Note that the default development build results in terrible runtime
+performance!* See [#Build Flags][] below for instructions on how to
+generate a release binary.
+
+
+### Build Flags
+The environment variable `CARGO_BUILD_FLAGS` can be used to provide
+additional arguments to `cargo build` when invoked via `make`. This can be
+provided optionally during `configure` and can be overridden when invoking
+`make`. For example:
+
+```sh
+# release build
+$ ./configure && make CARGO_BUILD_FLAGS=--release
+$ ./configure CARGO_BUILD_FLAGS=--release && make
+
+# dev build
+$ ./configure && make
+$ ./configure CARGO_BUILD_FLAGS=--release && make CARGO_BUILD_FLAGS=
+```