Skip to content

Commit 25d1989

Browse files
authored
Update README.md (#135)
1 parent 63fa872 commit 25d1989

File tree

1 file changed

+5
-28
lines changed

1 file changed

+5
-28
lines changed

README.md

+5-28
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ standard library, and documentation. It is modified to use Enzyme for AutoDiff.
99
Please configure this fork using the following command:
1010

1111
```
12-
mkdir build
13-
cd build
14-
../configure --enable-llvm-link-shared --enable-llvm-plugins --enable-llvm-enzyme --release-channel=nightly --enable-llvm-assertions --enable-clang --enable-lld --enable-option-checking --enable-ninja --disable-docs
12+
./configure --enable-llvm-link-shared --enable-llvm-plugins --enable-llvm-enzyme --release-channel=nightly --enable-llvm-assertions --enable-clang --enable-lld --enable-option-checking --enable-ninja --disable-docs
1513
```
1614

1715
Afterwards you can build rustc using:
1816
```
19-
../x.py build --stage 1 library
17+
x.py build --stage 1 library
2018
```
2119

2220
Afterwards rustc toolchain link will allow you to use it through cargo:
@@ -31,32 +29,11 @@ You can then run an examples from our [docs](https://enzyme.mit.edu/index.fcgi/r
3129
cargo +enzyme run --release
3230
```
3331

34-
## Enzyme Config
35-
To help with debugging, Enzyme can be configured using environment variables.
36-
```bash
37-
export ENZYME_PRINT_TA=1
38-
export ENZYME_PRINT_AA=1
39-
export ENZYME_PRINT=1
40-
export ENZYME_PRINT_MOD=1
41-
export ENZYME_PRINT_MOD_AFTER=1
42-
```
43-
The first three will print TypeAnalysis, ActivityAnalysis and the llvm-ir on a function basis, respectively.
44-
The last two variables will print the whole module directly before and after Enzyme differented the functions.
45-
46-
When experimenting with flags please make sure that EnzymeStrictAliasing=0
47-
is not changed, since it is required for Enzyme to handle enums correctly.
48-
4932
## Bug reporting
5033
Bugs are pretty much expected at this point of the development process.
51-
In order to help us please minimize the Rust code as far as possible.
52-
This tool might be a nicer helper: https://github.com/Nilstrieb/cargo-minimize
53-
If you have some knowledge of LLVM-IR we also greatly appreciate it if you could help
54-
us by compiling your minimized Rust code to LLVM-IR and reducing it further.
55-
56-
The only exception to this strategy is error based on "Can not deduce type of X",
57-
where reducing your example will make it harder for us to understand the origin of the bug.
58-
In this case please just try to inline all dependencies into a single crate or even file,
59-
without deleting used code.
34+
Any type of bug report is therefore highly appreciated. Documentation
35+
on how to best debug this fork and how to report errors can be found
36+
on our [website]: https://enzyme.mit.edu/index.fcgi/rust/Debugging.html
6037

6138

6239

0 commit comments

Comments
 (0)