Skip to content

Commit

Permalink
clarify RUSTFLAGS doc (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZuseZ4 authored Aug 11, 2024
1 parent 77c103d commit 069a6a2
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions src/Debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,10 @@ Otherwise we have various alternatives, including
Potentially also
[creduce](https://github.com/csmith-project/creduce)

### Supported Environment Variables
To support you while debugging, we have added support for various environment variables,
### Supported RUSTFLAGS
To support you while debugging, we have added support for an experimental `-Z autodiff` flag to `RUSTFLAGS`,
which allow changing the behaviour of Enzyme, without recompiling rustc.
If you change your environment variables, you may need to run `cargo clean` to see the new behaviour.
We currently support the following `RUSTFLAG` values for autodiff:
We currently support the following values for `autodiff`:
```bash
PrintTA // Print TypeAnalysis information
PrintAA // Print ActivityAnalysis information
Expand All @@ -81,7 +80,7 @@ Inline // Instructs Enzyme to apply additional inlining beyond LLVM's default
AltPipeline // Don't optimize IR before AD, but optimize the whole module twice after AD
```

You can combine multiple `RUSTFLAG` values using a comma as separator:
You can combine multiple `autodiff` values using a comma as separator:
```bash
RUSTFLAGS="-Z autodiff=LooseTypes,NoVecUnroll" cargo +enzyme build
```
Expand Down

0 comments on commit 069a6a2

Please sign in to comment.