Skip to content

Commit 8a59808

Browse files
committed
Improve readme
1 parent c869907 commit 8a59808

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

Readme.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> ⚠⚠⚠ Certain kinds of FFI don't work yet. ⚠⚠⚠
44
5-
The goal of this project is to create an alternative codegen backend for the rust compiler based on [Cranelift](https://github.com/bytecodealliance/wasmtime/blob/master/cranelift). This has the potential to improve compilation times in debug mode. If your project doesn't use any of the things listed under "Not yet supported", it should probably work fine. If not please open an issue.
5+
The goal of this project is to create an alternative codegen backend for the rust compiler based on [Cranelift](https://github.com/bytecodealliance/wasmtime/blob/master/cranelift). This has the potential to improve compilation times in debug mode. If your project doesn't use any of the things listed under "Not yet supported", it should work fine. If not please open an issue.
66

77
## Building
88

@@ -59,21 +59,7 @@ function jit_calc() {
5959

6060
## Env vars
6161

62-
<dl>
63-
<dt>CG_CLIF_JIT</dt>
64-
<dd>Enable JIT mode to immediately run a program instead of writing an executable file.</dd>
65-
<dt>CG_CLIF_JIT_ARGS</dt>
66-
<dd>When JIT mode is enable pass these arguments to the program.</dd>
67-
<dt>CG_CLIF_INCR_CACHE_DISABLED</dt>
68-
<dd>Don't cache object files in the incremental cache. Useful during development of cg_clif
69-
to make it possible to use incremental mode for all analyses performed by rustc without caching
70-
object files when their content should have been changed by a change to cg_clif.</dd>
71-
<dt>CG_CLIF_DISPLAY_CG_TIME</dt>
72-
<dd>If "1", display the time it took to perform codegen for a crate</dd>
73-
<dt>CG_CLIF_FUNCTION_SECTIONS</dt>
74-
<dd>Use a single section for each function. This will often reduce the executable size at the
75-
cost of making linking significantly slower.</dd>
76-
</dl>
62+
[see env_vars.md](docs/env_vars.md)
7763

7864
## Not yet supported
7965

docs/env_vars.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# List of env vars recognized by cg_clif
2+
3+
<dl>
4+
<dt>CG_CLIF_JIT</dt>
5+
<dd>Enable JIT mode to immediately run a program instead of writing an executable file.</dd>
6+
<dt>CG_CLIF_JIT_ARGS</dt>
7+
<dd>When JIT mode is enable pass these arguments to the program.</dd>
8+
<dt>CG_CLIF_INCR_CACHE_DISABLED</dt>
9+
<dd>Don't cache object files in the incremental cache. Useful during development of cg_clif
10+
to make it possible to use incremental mode for all analyses performed by rustc without caching
11+
object files when their content should have been changed by a change to cg_clif.</dd>
12+
<dt>CG_CLIF_DISPLAY_CG_TIME</dt>
13+
<dd>If "1", display the time it took to perform codegen for a crate</dd>
14+
<dt>CG_CLIF_FUNCTION_SECTIONS</dt>
15+
<dd>Use a single section for each function. This will often reduce the executable size at the
16+
cost of making linking significantly slower.</dd>
17+
</dl>

0 commit comments

Comments
 (0)