llvm-project/clang/docs
Tobias Grosser 741602461d 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
2014-02-28 09:11:08 +00:00
..
analyzer Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
tools Fix AST matcher documentation for overloaded matchers. 2014-02-24 10:40:22 +00:00
AddressSanitizer.rst [sanitizer] update the list of supported platforms in the docs 2014-01-31 10:49:34 +00:00
AttributeReference.rst AttributeReference: Document __single_inhertiance, __multiple_inheritance, __virtual_inheritance 2014-02-25 08:28:55 +00:00
AutomaticReferenceCounting.rst Documentation: formatting fixes 2013-03-13 14:26:35 +00:00
Block-ABI-Apple.rst Converted Block-ABI-Apple.txt => Block-ABI-Apple.rst. 2013-01-07 22:24:45 +00:00
Block-ABI-Apple.txt Converted Block-ABI-Apple.txt => Block-ABI-Apple.rst. 2013-01-07 22:24:45 +00:00
BlockLanguageSpec.rst Documentation: use monospaced font in BlockLanguageSpec, and fix a link to this 2012-12-20 20:51:59 +00:00
CMakeLists.txt [doxygen] Add a few missing variables to the doxygen.cfg.in for external search and cleaned up external_search_map. 2013-08-28 21:55:41 +00:00
ClangCheck.rst Add documentation for clang-format. 2013-01-09 21:49:28 +00:00
ClangFormat.rst clang-format-diff.py: Support -regex filter and more filename extensions 2013-12-10 13:51:53 +00:00
ClangFormatStyleOptions.rst clang-format: Improve documentation of DerivePointerBinding. 2014-02-13 12:51:50 +00:00
ClangPlugins.rst Remove buggy example code from the documentation 2014-01-26 05:08:07 +00:00
ClangTools.rst Fix grammar-o. 2013-11-08 22:15:02 +00:00
CrossCompilation.rst fix a typo 2013-11-26 13:28:51 +00:00
DataFlowSanitizer.rst Add support for -fsanitize-blacklist and default blacklists for DFSan. 2013-08-14 18:54:18 +00:00
DataFlowSanitizerDesign.rst DataFlowSanitizer: Add a design doc paragraph on checking ABI consistency. 2013-08-22 20:08:20 +00:00
DriverArchitecture.png
DriverInternals.rst docs: Convert DriverInternals to reST. 2012-12-21 00:16:53 +00:00
ExternalClangExamples.rst [docs] Add rtags to the external examples. 2013-03-12 16:07:31 +00:00
FAQ.rst Documentation: fix typo: stdard -> stdarg 2013-02-07 14:48:33 +00:00
HowToSetupToolingForLLVM.rst Fix spelling error and remove the part about CMake having experimental Ninja support since 2.8.9 has been released some time ago. 2013-01-11 07:23:53 +00:00
InternalsManual.rst Add 'remark' diagnostic type in 'clang' 2014-02-28 09:11:08 +00:00
IntroductionToTheClangAST.rst Suggest people use -Xclang not -cc1 when passing options to the frontend. 2013-10-08 19:50:01 +00:00
JSONCompilationDatabase.rst Documentation: fix escaping in JSON example 2013-01-30 17:58:39 +00:00
LanguageExtensions.rst Moving the documentation for the format attribute into AttrDocs. 2014-02-21 14:36:13 +00:00
LeakSanitizer.rst Rewrite docs/LeakSanitizer.rst. Add it to index. 2013-12-10 20:10:30 +00:00
LibASTMatchers.rst docs: Fix up HTML links to proper reST links. 2013-01-02 13:07:47 +00:00
LibASTMatchersReference.html Fix AST matcher documentation for overloaded matchers. 2014-02-24 10:40:22 +00:00
LibASTMatchersTutorial.rst Updated tutorial code according to the changes in r197139. 2014-02-19 16:11:38 +00:00
LibFormat.rst Add documentation for clang-format. 2013-01-09 21:49:28 +00:00
LibTooling.rst Fix indentation of a code example in LibTooling's documentation. 2014-02-06 20:16:05 +00:00
Makefile Add trunk revision number on the online HTML docs. 2013-10-27 05:00:50 +00:00
Makefile.sphinx docs: Copy Block-ABI-Apple.txt to output. 2013-01-07 21:46:35 +00:00
MemorySanitizer.rst [sanitizer] update the list of supported platforms in the docs 2014-01-31 10:49:34 +00:00
Modules.rst Modules: Fix malformed reStructuredText 2014-02-25 06:22:25 +00:00
ObjectiveCLiterals.rst Remove HTML codes from a .rst file. The proper HTML code will be added back 2014-01-25 01:32:39 +00:00
PCHInternals.rst [docs] The stat cache has been removed from the PCH, update the docs to remove mentions of it. 2013-02-14 00:12:44 +00:00
PCHLayout.graffle
PCHLayout.png
PTHInternals.rst Documentation: PTHInternals: use correct adornments and fix typos 2012-12-23 18:39:54 +00:00
RAVFrontendAction.rst docs: More reST conversion. 2012-12-13 01:10:46 +00:00
README.txt Add docs/README.txt to point to llvm/docs/README.txt. 2013-01-02 23:25:41 +00:00
ReleaseNotes.rst Fixing the indentation of the RST content in the release notes. Fixes two warnings when building the HTML content and improves the format of the resulting content. 2014-02-23 16:27:21 +00:00
SanitizerSpecialCaseList.rst Documentation for sanitizer special case list format and -f(no-)?sanitize-blacklist flag 2013-08-07 08:23:32 +00:00
ThreadSafetyAnalysis.rst Some of these headings had the incorrect number of "underlines" and so would get warnings when generating the content from Sphinx. No functional changes intended. 2014-02-19 20:43:58 +00:00
ThreadSanitizer.rst [sanitizer] update the list of supported platforms in the docs 2014-01-31 10:49:34 +00:00
Tooling.rst docs: "clang tools" are not a different interface. 2013-01-08 04:42:09 +00:00
UsersManual.rst Add 'remark' diagnostic type in 'clang' 2014-02-28 09:11:08 +00:00
conf.py Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
doxygen.cfg.in [doxygen] Add a few missing variables to the doxygen.cfg.in for external search and cleaned up external_search_map. 2013-08-28 21:55:41 +00:00
doxygen.css docs/doxygen.css: Import .memitem, .memproto and .memdoc from llvm/doxygen. 2011-08-12 06:24:04 +00:00
doxygen.footer Add trunk revision number on the online HTML docs. 2013-10-27 05:00:50 +00:00
doxygen.header
doxygen.intro
index.rst Until attribute documentation is implemented as a server-side feature, I will be manually committing AttributeReference.rst so that attribute documentation can be on the live server instead of simply disappearing from the language extensions page without obvious replacement. 2014-02-19 23:09:37 +00:00
make.bat docs: Initial Sphinx setup for Clang. 2012-12-12 23:02:30 +00:00

README.txt

See llvm/docs/README.txt