[PATCH] D144894: [clang] Documents clang-scan-deps requirements.

[Mark de Wever via Phabricator via cfe-commits]

Mordante created this revision.
Mordante added a reviewer: ChuanqiXu.
Herald added a project: All.
Mordante requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.

This was discussed in https://llvm.org/PR61006.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D144894

Files:
  clang/docs/StandardCPlusPlusModules.rst


Index: clang/docs/StandardCPlusPlusModules.rst
===================================================================
--- clang/docs/StandardCPlusPlusModules.rst
+++ clang/docs/StandardCPlusPlusModules.rst
@@ -1033,6 +1033,12 @@
 
   $ clang-scan-deps -format=p1689 -- <path-to-compiler-executable>/clang++ -std=c++20 impl_part.cppm -c -o impl_part.o
 
+.. warning::
+
+   The ``<path-to-compiler-executable>/clang++`` should point to the real
+   binary and not to a symlink. If it points to a symlink the include paths
+   will not be correctly resolved.
+
 And we'll get:
 
 .. code-block:: text


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D144894.500843.patch
Type: text/x-patch
Size: 596 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20230227/8db07e7b/attachment.bin>