[libcxx-commits] [PATCH] D157784: [docs] Fix reST formatting in UsingLibcxx IWYU section
Kim Gräsman via Phabricator via libcxx-commits
libcxx-commits at lists.llvm.org
Sat Aug 12 08:29:53 PDT 2023
kimgr created this revision.
Herald added a project: All.
kimgr requested review of this revision.
Herald added a project: libc++.
Herald added a subscriber: libcxx-commits.
Herald added a reviewer: libc++.
The link syntax was missing a trailing underscore, and there was an
extraneous backtick on the reference to IWYU's libcxx.imp.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D157784
Files:
libcxx/docs/UsingLibcxx.rst
Index: libcxx/docs/UsingLibcxx.rst
===================================================================
--- libcxx/docs/UsingLibcxx.rst
+++ libcxx/docs/UsingLibcxx.rst
@@ -127,7 +127,7 @@
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 @@
$ 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:
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D157784.549615.patch
Type: text/x-patch
Size: 1077 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libcxx-commits/attachments/20230812/c4ec45ad/attachment-0001.bin>
More information about the libcxx-commits
mailing list