summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDrSlump <drslump@pollinimini.net>2018-08-13 11:24:58 +0200
committerDrSlump <drslump@pollinimini.net>2018-08-13 11:24:58 +0200
commit6a0751e81a31d08d8b31a434018176adcdd989d7 (patch)
tree79d78c96490d1c4cdfe39665d47c150764e453b4
parente839c01f5b8b9fbe0d297be9d9bf8a429b49a1b1 (diff)
downloadNim-6a0751e81a31d08d8b31a434018176adcdd989d7.tar.gz
Fixes #7586: Adds documentation for hints
-rw-r--r--doc/nimc.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/nimc.rst b/doc/nimc.rst
index fca5b273c..9c81d912f 100644
--- a/doc/nimc.rst
+++ b/doc/nimc.rst
@@ -68,6 +68,46 @@ User                             Some user defined warning.
 ==========================       ============================================
 
 
+List of hints
+-------------
+
+Each hint can be activated individually with ``--hint[NAME]:on|off`` or in a
+``push`` pragma.
+
+==========================       ============================================
+Name                             Description
+==========================       ============================================
+CC                               Shows when the C compiler is called.
+CodeBegin
+CodeEnd
+CondTrue
+Conf                             A config file was loaded.
+ConvToBaseNotNeeded
+ConvFromXtoItselfNotNeeded
+Dependency
+Exec                             Program is executed.
+ExprAlwaysX
+ExtendedContext
+GCStats                          Dumps statistics about the Garbage Collector.
+GlobalVar                        Shows global variables declarations.
+LineTooLong                      Line exceeds the maximum length.
+Link                             Linking phase.
+Name
+Path                             Search paths modifications.
+Pattern
+Performance
+Processing                       Artifact being compiled.
+QuitCalled
+Source                           The source line that triggered a diagnostic
+                                 message.
+StackTrace
+Success, SuccessX                Successful compilation of a library or a binary.
+User
+UserRaw
+XDeclaredButNotUsed              Unused symbols in the code.
+==========================       ============================================
+
+
 Verbosity levels
 ----------------