summaryrefslogtreecommitdiff
path: root/COMPILING.md
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@gnome.org>2018-02-27 13:48:42 -0600
committerFederico Mena Quintero <federico@gnome.org>2018-02-27 13:49:41 -0600
commitb1a4bfe98251c2975ea3da6610b878f080d70827 (patch)
tree5b5befa356b0ab05cefbc196e0fc1a30be38b061 /COMPILING.md
parent3a8a5576fc28dd146a70e8058e89e44800b4cbed (diff)
downloadlibrsvg-b1a4bfe98251c2975ea3da6610b878f080d70827.tar.gz
Add a LIBRSVG_DEBUG=yes env var for configure; works like --enable-debug
Diffstat (limited to 'COMPILING.md')
-rw-r--r--COMPILING.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/COMPILING.md b/COMPILING.md
index d8fd1226..f063341f 100644
--- a/COMPILING.md
+++ b/COMPILING.md
@@ -168,8 +168,11 @@ that you want to pass to the C compiler.
## Controlling debug or release mode for Rust
-For the Rust part of librsvg, we have an `--enable-debug` flag that
-you can pass to the `configure` script. When enabled, the Rust
+* With a `configure` option: `--enable-debug` or `--disable-debug`
+* With an environment variable: `LIBRSVG_DEBUG=yes` or `LIBRSVG_DEBUG=no`
+
+For the Rust part of librsvg, we have a flag that
+you can pass at `configure` time. When enabled, the Rust
sub-library will have debugging information and no compiler
optimizations. *This flag is off by default:* if the flag is not
specified, the Rust sub-library will be built in release mode (no
@@ -187,9 +190,13 @@ life easier to binary distributions. Librsvg's build scripts will add
`--release` to the Cargo command line by default.
Developers can request a debug build of the Rust sub-library by
-passing `--enable-debug` to the `configure` script. This will omit
-the `--release` option from Cargo, so that it will build the Rust
-sub-library in debug mode.
+passing `--enable-debug` to the `configure` script, or by setting the
+`LIBRSVG_DEBUG=yes` environment variable before calling `configure`.
+This will omit the `--release` option from Cargo, so that it will
+build the Rust sub-library in debug mode.
+
+In case both the environment variable and the command-line option are
+specified, the command-line option overrides the env var.
# Cross-compilation