aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2017-02-06 08:35:41 +0100
committerTristan Gingold <tgingold@free.fr>2017-02-06 08:35:41 +0100
commitdb4b46e5c5c5f98ccba37fc18a9ac48a0cba0ff5 (patch)
tree93558687cf658638e3e154aad8f6c0871a8786bc /doc
parente27f10a33792285471c66dd2b5f97bc47a93efc9 (diff)
downloadghdl-db4b46e5c5c5f98ccba37fc18a9ac48a0cba0ff5.tar.gz
ghdl-db4b46e5c5c5f98ccba37fc18a9ac48a0cba0ff5.tar.bz2
ghdl-db4b46e5c5c5f98ccba37fc18a9ac48a0cba0ff5.zip
Add color diagnostics, show diagnostic option.
Diffstat (limited to 'doc')
-rw-r--r--doc/Invoking_GHDL.rst38
1 files changed, 36 insertions, 2 deletions
diff --git a/doc/Invoking_GHDL.rst b/doc/Invoking_GHDL.rst
index fb121ed22..f75345f2f 100644
--- a/doc/Invoking_GHDL.rst
+++ b/doc/Invoking_GHDL.rst
@@ -414,6 +414,9 @@ manual for details.
:samp:`state1` are homograph, the enumeration literal is hidden in the
immediate scope of the constant).
+ This option also relaxes the rules about pure functions. Violations
+ result in warnings instead of errors.
+
.. option:: -fpsl
@@ -480,6 +483,7 @@ manual for details.
Be verbose. For example, for analysis, elaboration and make commands, GHDL
displays the commands executed.
+
Passing options to other programs
=================================
@@ -507,6 +511,20 @@ GCC manual for details on GCC options.
Pass `OPTION` as an option to the linker.
+GHDL Diagnostics Control
+========================
+
+.. option:: -f[no-]color-diagnostics
+
+ Control whether diagnostic messages are displayed in color. The
+ default is on when the standard output is a terminal.
+
+.. option:: -f[no-]diagnostics-show-option
+
+ Control whether the warning option is displayed at the end of
+ warning messages, so that user can easily know how to disable it.
+
+
GHDL warnings
=============
@@ -514,8 +532,8 @@ Some constructions are not erroneous but dubious. Warnings are diagnostic
messages that report such constructions. Some warnings are reported only
during analysis, others during elaboration.
-You could disable a warning by using the :samp:`--warn-no-XXX`
-instead of :samp:`--warn-XXX`.
+You could disable a warning by using the :samp:`--warn-no-XXX` or
+:samp:`-Wno-XX` instead of :samp:`--warn-XXX` or :samp:`-WXXX`.
.. option:: --warn-reserved
@@ -592,6 +610,22 @@ instead of :samp:`--warn-XXX`.
When this option is set, warnings are considered as errors.
+.. option:: --warn-nested-comment
+
+ Emit a warning if a :samp:`/*` appears within a block comment (vhdl 2008).
+
+
+.. option:: --warn-parenthesis
+
+ Emit a warning in case of weird use of parenthesis
+
+
+.. option:: --warn-runtime-error
+
+ Emit a warning in case of runtime error that is detected during
+ analysis.
+
+
Rebuilding commands
===================