diff options
| author | Tobias Grosser <tobias@grosser.es> | 2014-02-28 09:11:08 +0000 |
|---|---|---|
| committer | Tobias Grosser <tobias@grosser.es> | 2014-02-28 09:11:08 +0000 |
| commit | 741602461d2079c682916bce6701c39acb08bbd3 (patch) | |
| tree | e83731354fa81b3ece9f6f772f98ca5e2cc6ee87 /clang/docs/UsersManual.rst | |
| parent | e8d4c9a2c726e4847f791ec9c4d8593608699751 (diff) | |
| download | bcm5719-llvm-741602461d2079c682916bce6701c39acb08bbd3.tar.gz bcm5719-llvm-741602461d2079c682916bce6701c39acb08bbd3.zip | |
Add 'remark' diagnostic type in 'clang'
A 'remark' is information that is not an error or a warning, but rather some
additional information provided to the user. In contrast to a 'note' a 'remark'
is an independent diagnostic, whereas a 'note' always depends on another
diagnostic.
A typical use case for remark nodes is information provided to the user, e.g.
information provided by the vectorizer about loops that have been vectorized.
This patch provides the initial implementation of 'remarks'. It includes the
actual definiton of the remark nodes, their printing as well as basic parameter
handling. We are reusing the existing diagnostic parameters which means a remark
can be enabled with normal '-Wdiagnostic-name' flags and can be upgraded to
an error using '-Werror=diagnostic-name'. '-Werror' alone does not upgrade
remarks.
This patch is by intention minimal in terms of parameter handling. More
experience and more discussions will most likely lead to further enhancements
in the parameter handling.
llvm-svn: 202475
Diffstat (limited to 'clang/docs/UsersManual.rst')
| -rw-r--r-- | clang/docs/UsersManual.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst index 4ca8435c368..ba915018230 100644 --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -112,11 +112,11 @@ Options to Control Error and Warning Messages .. option:: -w - Disable all warnings. + Disable all diagnostics. .. option:: -Weverything - :ref:`Enable all warnings. <diagnostics_enable_everything>` + :ref:`Enable all diagnostics. <diagnostics_enable_everything>` .. option:: -pedantic @@ -582,6 +582,7 @@ All diagnostics are mapped into one of these 5 classes: - Ignored - Note +- Remark - Warning - Error - Fatal @@ -722,11 +723,12 @@ is treated as a system header. .. _diagnostics_enable_everything: -Enabling All Warnings -^^^^^^^^^^^^^^^^^^^^^ +Enabling All Diagnostics +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In addition to the traditional ``-W`` flags, one can enable **all** -warnings by passing :option:`-Weverything`. This works as expected with +diagnostics by passing :option:`-Weverything`. This works as expected +with :option:`-Werror`, and also includes the warnings from :option:`-pedantic`. Note that when combined with :option:`-w` (which disables all warnings), that |
