[libcxx-commits] [libcxx] 3920c1c - [docs] Fix reST formatting in UsingLibcxx IWYU section
Nikolas Klauser via libcxx-commits
libcxx-commits at lists.llvm.org
Tue Aug 15 12:59:53 PDT 2023
Author: Kim Gräsman
Date: 2023-08-15T12:16:15-07:00
New Revision: 3920c1c5b1e88856e85f3c042acbb9f3bb351608
URL: https://github.com/llvm/llvm-project/commit/3920c1c5b1e88856e85f3c042acbb9f3bb351608
DIFF: https://github.com/llvm/llvm-project/commit/3920c1c5b1e88856e85f3c042acbb9f3bb351608.diff
LOG: [docs] Fix reST formatting in UsingLibcxx IWYU section
The link syntax was missing a trailing underscore, and there was an
extraneous backtick on the reference to IWYU's libcxx.imp.
Reviewed By: #libc, philnik
Spies: Mordante, libcxx-commits
Differential Revision: https://reviews.llvm.org/D157784
Added:
Modified:
libcxx/docs/UsingLibcxx.rst
Removed:
################################################################################
diff --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index dea4ab53d20306..e6b22bbcce83e2 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -127,7 +127,7 @@ provide pretty-printers itself. Those can be used as:
include-what-you-use (IWYU)
===========================
-libc++ provides an IWYU `mapping file <https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUMappings.md>`,
+libc++ provides an IWYU `mapping file <https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUMappings.md>`_,
which drastically improves the accuracy of the tool when using libc++. To use the mapping file with
IWYU, you should run the tool like so:
@@ -135,7 +135,7 @@ IWYU, you should run the tool like so:
$ include-what-you-use -Xiwyu /path/to/libcxx/include/libcxx.imp file.cpp
-If you would prefer to not use that flag, then you can replace ``/path/to/include-what-you-use/share/libcxx.imp```
+If you would prefer to not use that flag, then you can replace ``/path/to/include-what-you-use/share/libcxx.imp``
file with the libc++-provided ``libcxx.imp`` file.
.. _termination-handler:
More information about the libcxx-commits
mailing list