idris-lang/Idris2
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris2.git synced 2024-12-26 05:01:34 +03:00
Code Issues Projects Releases Wiki Activity

Add incremental compilation note to INSTALL.md

Browse Source
This commit is contained in:
Edwin Brady 2021-06-27 16:35:43 +01:00
parent 5a84623629
commit 84c2a497bc
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -9,7 +9,8 @@
In incremental mode, the final build step is much faster than in whole In incremental mode, the final build step is much faster than in whole
program mode (the default), at the cost of runtime performance being about program mode (the default), at the cost of runtime performance being about
half as good. The `--whole-program` flag overrides incremental compilation, half as good. The `--whole-program` flag overrides incremental compilation,
and reverts to whole program compilation. and reverts to whole program compilation. Incremental compilation is currently
supported only by the Chez Scheme back end.
## v0.4.0 ## v0.4.0

11
INSTALL.md
View File

@ -88,7 +88,14 @@ that everything has worked correctly. Assuming that `idris2` is in your
After `make all`, type `make test` to check everything works. This uses the After `make all`, type `make test` to check everything works. This uses the
executable in `./build/exec`. executable in `./build/exec`.
### 6: (Optional) Installing the Idris 2 API ### 6: (Optional) Enabling incremental compilation
If you are working on Idris, incremental compilation means that rebuilds are
much faster, at the cost of runtime performance being slower. To enable
incremental compilation for the Chez back end, set the environment variable
`IDRIS2_INC_CGS=chez`, or set the `--inc chez` flag in `idris2.ipkg`.
### 7: (Optional) Installing the Idris 2 API
You'll only need this if you're developing support tools, such as an external You'll only need this if you're developing support tools, such as an external
code generator. To do so, once everything is successfully installed, type: code generator. To do so, once everything is successfully installed, type:
@ -99,7 +106,7 @@ The API will only work if you've completed the self-hosting step, step 4, since
the intermediate code versions need to be consistent throughout. Otherwise, you the intermediate code versions need to be consistent throughout. Otherwise, you
will get an `Error in TTC: TTC data is in an older format` error. will get an `Error in TTC: TTC data is in an older format` error.
### 7: (Optional) Shell Auto-completion ### 8: (Optional) Shell Auto-completion
Idris2 supports tab auto-completion for Bash-like shells. Idris2 supports tab auto-completion for Bash-like shells.