Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-29 16:41:27 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[docs] Clarify compile_flags.txt subtleties

Browse Source 
See confusion e.g. in https://github.com/clangd/clangd/issues/637
This commit is contained in:
Sam McCall 2021-01-31 11:16:52 +01:00
parent be997cead7
commit 095f08653f
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
clang/docs/JSONCompilationDatabase.rst
View File

@ -94,6 +94,18 @@ to parse C++ code in the source tree.
Alternatives
============
For simple projects, Clang tools also recognize a compile_flags.txt file.
This should contain one flag per line. The same flags will be used to compile
any file.
For simple projects, Clang tools also recognize a ``compile_flags.txt`` file.
This should contain one argument per line. The same flags will be used to
compile any file.
Example:
::
-xc++
-I
libwidget/include/
Here ``-I libwidget/include`` is two arguments, and so becomes two lines.
Paths are relative to the directory containing ``compile_flags.txt``.