summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2018-08-14 11:26:53 +0100
committerGitHub <noreply@github.com>2018-08-14 11:26:53 +0100
commit9a7e6be62f6ee8818c6ef2f1504a6dd75774a616 (patch)
treebc389291ad247a42faaee20517a42cc3cf0041e1
parentbc957ace2eb219a969c5cd035af40007b1e5d885 (diff)
parent6a0751e81a31d08d8b31a434018176adcdd989d7 (diff)
downloadNim-9a7e6be62f6ee8818c6ef2f1504a6dd75774a616.tar.gz
Merge pull request #8625 from drslump/fixes-7586-documentation-on-hints
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
 ----------------