on master help sign in
Fixes #2932 with better documentation.

The env vars used by idris were not well documented, nor how to interact with paths and these vars from the Idris CLI. This commit updates the documentaton.

commit88241edb8659387eb66b6714736fb94ceea0ba69 authorJan de Muijnck-Hughes <jfdm@st-andrews.ac.uk> dateSat 26 Mar 2016, 10:04 (11 years ago) parent3303747
1 file changed+28−2
docs/reference/compilation.rst+28−2
docs/reference/compilation.rst+28−2
@@ -2,8 +2,7 @@
22Compilation and Logging
33***********************
44
5−
6−This section provides highlights of the Idris compilation process, and
5+This section provides information about the Idris compilation process, and
76provides details over how you can follow the process through logging.
87
98Compilation Process
@@ -78,3 +77,30 @@ logging level between: 1 to 10 using the command-line option: ``--log
7877+ Level 8:
7978+ Level 9:
8079+ Level 10: Further details elaboration.
80+
81+Environment Variables
82+=====================
83+
84+Several paths set by default within the Idris compiler can be
85+overridden through environment variables. The provided variables are:
86+
87+* `IDRIS_CC` Change the `C` compiler used by the `C` backend.
88+* `IDRIS_CFLAGS` Change the `C` flags passed to the `C` compiler.
89+* `TARGET` Change the target directory to generate files.
90+* `IDRIS_LIBRARY_PATH` Change the location of where installed packages are found.
91+
92+Alternativly, and perhaps a cleaner approach is to configure these
93+options using the CLI options. Idris also supports options to augment
94+the paths used, and pass options to the code generator backend.
95+
96+The option `--cg-opt <ARG>` can be used to pass options to the code
97+generator. The format of `<ARG>` is dependent on the selected backend.
98+
99+Further, Idris does support multiple include paths. The CLI option
100+`-i <dir>` allows you to add a directory to the search path; this
101+option can be used multiple times. This is a cleaner option when you
102+wish to add single directories to the `IDRIS_LIBRARY_PATH` than
103+ammending `IDRIS_LIBRARY_PATH` directly.
104+
105+Moreover, rather than using `TARGET` the CLI option `--ibcsubdir` can
106+be used to direct where built IBC files are placed.