[clang-tools-extra] 058d212 - [clang-tidy] Use literal block instead of code block (NFC)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Jan 19 14:24:11 PST 2022
Author: Richard
Date: 2022-01-19T15:23:48-07:00
New Revision: 058d2123792da54ae7460fea0946d2c90a032e1c
URL: https://github.com/llvm/llvm-project/commit/058d2123792da54ae7460fea0946d2c90a032e1c
DIFF: https://github.com/llvm/llvm-project/commit/058d2123792da54ae7460fea0946d2c90a032e1c.diff
LOG: [clang-tidy] Use literal block instead of code block (NFC)
I used a C++ code block in check documentation to show example
output from clang-tidy, but since the example output isn't
kosher C++, sphinx didn't like that when it went to syntax
highlight the block. So switch to a literal block instead
and forego any highlighting.
Fixes build error
<https://lab.llvm.org/buildbot/#/builders/115/builds/21145>
Added:
Modified:
clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-macro-usage.rst
Removed:
################################################################################
diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-macro-usage.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-macro-usage.rst
index ca7e54429c236..6c05a9f704ca4 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-macro-usage.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-macro-usage.rst
@@ -26,9 +26,7 @@ Examples:
#define DLLEXPORTS __declspec(dllimport)
#endif
-results in the following warnings:
-
-.. code-block:: c++
+results in the following warnings::
4 warnings generated.
test.cpp:1:9: warning: macro 'C' used to declare a constant; consider using a 'constexpr' constant [cppcoreguidelines-macro-usage]
More information about the cfe-commits
mailing list