on master help sign in
Merge pull request #2868 from jfdm/logging-docs

Fixes #2865 by adding documentation for the category based logger.

commit6b74ec698b430dea4f3731e7a1077993c1b66298 authorJan de Muijnck-Hughes <jfdm@users.noreply.github.com> dateSun 20 Dec 2015, 08:49 (11 years ago) parentd3d679eec3a454
1 file changed+21−2
docs/reference/compilation.rst+21−2
docs/reference/compilation.rst+21−2
@@ -45,8 +45,27 @@ Use of this option will still result in the generation of the Idris binary ``.ib
4545Logging Output
4646==============
4747
48−Logging of the Idris output can be used to diagnose problems with the compilation of your program.
49−Idris supports the logging at various different levels of verbosity: 1 to 10.
48+The internal operation of Idris is captured using a category based logger.
49+Currently, the logging infrastructure has support for the following categories:
50+
51++ Parser
52++ Elaborator
53++ Code generation
54++ Erasure
55++ Coverage Checking
56++ IBC generation
57+
58+
59+These categories are specified using the command-line option:
60+``--logging-categories CATS``, where ``CATS`` is a quoted colon
61+seperated string of the categories you want to see. By default if this
62+option is not specified all categories are allowed. Sub-categories
63+have yet to be defined but will be in the future, especially for the
64+elaborator.
65+
66+Further, the verbosity of logging can be controlled by specifying a
67+logging level between: 1 to 10 using the command-line option: ``--log
68+<level>``.
5069
5170+ Level 0: Show no logging output. Default level
5271+ Level 1: High level details of the compilation process.