[libcxx-commits] [libcxx] eac0b67 - [docs] Fix include-what-you-use example

Mark de Wever via libcxx-commits libcxx-commits at lists.llvm.org
Sat Aug 19 04:33:13 PDT 2023


Author: Kim Gräsman
Date: 2023-08-19T13:33:07+02:00
New Revision: eac0b67ed1da34644c33ae3ae325ab078d52e818

URL: https://github.com/llvm/llvm-project/commit/eac0b67ed1da34644c33ae3ae325ab078d52e818
DIFF: https://github.com/llvm/llvm-project/commit/eac0b67ed1da34644c33ae3ae325ab078d52e818.diff

LOG: [docs] Fix include-what-you-use example

The --mapping_file switch was missing; the example would have been
rejected.

Reviewed By: #libc, Mordante

Differential Revision: https://reviews.llvm.org/D157785

Added: 
    

Modified: 
    libcxx/docs/UsingLibcxx.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index e6b22bbcce83e2..ea8c415e280b7a 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -133,7 +133,7 @@ IWYU, you should run the tool like so:
 
 .. code-block:: bash
 
-  $ include-what-you-use -Xiwyu /path/to/libcxx/include/libcxx.imp file.cpp
+  $ include-what-you-use -Xiwyu --mapping_file=/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``
 file with the libc++-provided ``libcxx.imp`` file.


        


More information about the libcxx-commits mailing list