Skip to content

Commit

Permalink
[docs] Fix reST formatting in UsingLibcxx IWYU section
Browse files Browse the repository at this point in the history
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
  • Loading branch information
kimgr authored and philnik777 committed Aug 15, 2023
1 parent b7c7b1e commit 3920c1c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions libcxx/docs/UsingLibcxx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,15 @@ 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:

.. code-block:: bash
$ 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:
Expand Down

0 comments on commit 3920c1c

Please sign in to comment.