[clang] 8dbeb41 - [clang] Documents clang-scan-deps requirements.

[Mark de Wever via cfe-commits]

Author: Mark de Wever
Date: 2023-02-28T18:16:28+01:00
New Revision: 8dbeb41f8ebda2914433a8fb7ee1012602f20922

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

LOG: [clang] Documents clang-scan-deps requirements.

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

Reviewed By: ChuanqiXu

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

Added: 
    

Modified: 
    clang/docs/StandardCPlusPlusModules.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/StandardCPlusPlusModules.rst b/clang/docs/StandardCPlusPlusModules.rst
index 8447a44e3f8d..816199052f2b 100644
--- a/clang/docs/StandardCPlusPlusModules.rst
+++ b/clang/docs/StandardCPlusPlusModules.rst
@@ -1033,6 +1033,12 @@ the user can choose to get the dependency information per file. For example:
 
   $ 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