git.iko.soy/Idris-dev
on master help sign in
Amended docs and updated CHANGELOG.
a0d1566Jan de Muijnck-Hughes
CHANGELOG.md+7−3
compare with master
unifiedsplit
@@ -40,10 +40,14 @@
40
40
41* Idris' documentation system now displays the documentation for auto
41* Idris' documentation system now displays the documentation for auto
42 implicits in the output of `:doc`. This is tested for in `docs005`.
42 implicits in the output of `:doc`. This is tested for in `docs005`.
43−
44* New command line flag `--info` that displays information about the installation.
43* New command line flag `--info` that displays information about the installation.
45−
46* New command line flag `--sourcepath <dir>` that allows adding directories to the source search path.
44* New command line flag `--sourcepath <dir>` that allows adding directories to the source search path.
45+* Allow 'installation' of a package's IdrisDoc documentation into a central location. The default location is the subdirectory `docs` of Idris' data directory.
46+ * New flag `--installdoc <ipkg>` provided to install documentation
47+ * New flag `--docdir` provided to show default documentation installation location.
48+ * New environment variable `IDRIS_DOC_PATH` to allow specification of an alternative installation path for documentation.
49+* Semantic meaning behind several environment variables has been clarified in documentation and code. See compilation section of the reference manual for more details.
50+
47## Miscellaneous updates
51## Miscellaneous updates
48
52
49* The test suite now uses [tasty-golden](https://hackage.haskell.org/package/tasty-golden). New tests must be registered in `test/TestData.hs`, as explained in the relevant `README.md`.
53* The test suite now uses [tasty-golden](https://hackage.haskell.org/package/tasty-golden). New tests must be registered in `test/TestData.hs`, as explained in the relevant `README.md`.
@@ -51,7 +55,7 @@
51
55
52## UI Changes
56## UI Changes
53
57
54−* The :e command can now handle an $EDITOR with arguments in it, like "emacs -nw"
58+* The :e command can now handle an $EDITOR with arguments in it, like "emacs -nw"
55
59
56
60
57# New in 0.12:
61# New in 0.12:
docs/reference/compilation.rst+27−19
@@ -86,22 +86,30 @@ overridden through environment variables. The provided variables are:
86
86
87* `IDRIS_CC` Change the `C` compiler used by the `C` backend.
87* `IDRIS_CC` Change the `C` compiler used by the `C` backend.
88* `IDRIS_CFLAGS` Change the `C` flags passed to the `C` compiler.
88* `IDRIS_CFLAGS` Change the `C` flags passed to the `C` compiler.
89−* `TARGET` Change the target directory to generate files.
89+* `TARGET` Change the target directory i.e. `data dir` where Idris installs files when installing using Cabal/Stack.
90−* `IDRIS_LIBRARY_PATH` Change the location of where installed packages are found.
90+* `IDRIS_LIBRARY_PATH` Change the location of where installed packages are found/installed.
91−
91+* `IDRIS_DOC_PATH` Change the location of where generated idrisdoc for packages are installed.
92−Alternativly, and perhaps a cleaner approach is to configure these
92+
93+.. note::
94+
95+ In versions of Idris prior to 0.12.3 the environment variables
96+ `IDRIS_LIBRARY_PATH` and `TARGET` were both used to affect the
97+ installation of single packages and direct where Idris installed
98+ its data. The meaning of these variables has changed, and command
99+ line options are preferred when changing where individual packages
100+ are installed.
101+
102+The CLI option `--ibcsubdir` can be used to direct where generated IBC
103+files are placed. However, this means Idris will install files in a
104+non-standard location separate from the rest of the installed
105+packages. The CLI option `--idrispath <dir>` allows you to add a
106+directory to the library search path; this option can be used multiple
107+times and can be shortened to `-i <dir>`. Similary, the `--sourcepath
108+<dir>` option can be used to add directories to the source search
109+path. There is no shortened version for this option as `-s` is a
110+reserved flag.
111+
93−options using the CLI options. Idris also supports options to augment
112+Further, Idris also supports options to augment the paths used, and
94−the paths used, and pass options to the code generator backend.
113+pass options to the code generator backend. The option `--cg-opt
95−
96−The option `--cg-opt <ARG>` can be used to pass options to the code
114+<ARG>` can be used to pass options to the code generator. The format
97−generator. The format of `<ARG>` is dependent on the selected backend.
115+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 library 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−To add directories to the source search path, use the `--sourcepath <dir>` option.
105−
106−Moreover, rather than using `TARGET` the CLI option `--ibcsubdir` can
107−be used to direct where built IBC files are placed.