1*67e74705SXin Li========== 2*67e74705SXin LiClangCheck 3*67e74705SXin Li========== 4*67e74705SXin Li 5*67e74705SXin Li`ClangCheck` is a small wrapper around :doc:`LibTooling` which can be used to 6*67e74705SXin Lido basic error checking and AST dumping. 7*67e74705SXin Li 8*67e74705SXin Li.. code-block:: console 9*67e74705SXin Li 10*67e74705SXin Li $ cat <<EOF > snippet.cc 11*67e74705SXin Li > void f() { 12*67e74705SXin Li > int a = 0 13*67e74705SXin Li > } 14*67e74705SXin Li > EOF 15*67e74705SXin Li $ ~/clang/build/bin/clang-check snippet.cc -ast-dump -- 16*67e74705SXin Li Processing: /Users/danieljasper/clang/llvm/tools/clang/docs/snippet.cc. 17*67e74705SXin Li /Users/danieljasper/clang/llvm/tools/clang/docs/snippet.cc:2:12: error: expected ';' at end of 18*67e74705SXin Li declaration 19*67e74705SXin Li int a = 0 20*67e74705SXin Li ^ 21*67e74705SXin Li ; 22*67e74705SXin Li (TranslationUnitDecl 0x7ff3a3029ed0 <<invalid sloc>> 23*67e74705SXin Li (TypedefDecl 0x7ff3a302a410 <<invalid sloc>> __int128_t '__int128') 24*67e74705SXin Li (TypedefDecl 0x7ff3a302a470 <<invalid sloc>> __uint128_t 'unsigned __int128') 25*67e74705SXin Li (TypedefDecl 0x7ff3a302a830 <<invalid sloc>> __builtin_va_list '__va_list_tag [1]') 26*67e74705SXin Li (FunctionDecl 0x7ff3a302a8d0 </Users/danieljasper/clang/llvm/tools/clang/docs/snippet.cc:1:1, line:3:1> f 'void (void)' 27*67e74705SXin Li (CompoundStmt 0x7ff3a302aa10 <line:1:10, line:3:1> 28*67e74705SXin Li (DeclStmt 0x7ff3a302a9f8 <line:2:3, line:3:1> 29*67e74705SXin Li (VarDecl 0x7ff3a302a980 <line:2:3, col:11> a 'int' 30*67e74705SXin Li (IntegerLiteral 0x7ff3a302a9d8 <col:11> 'int' 0)))))) 31*67e74705SXin Li 1 error generated. 32*67e74705SXin Li Error while processing snippet.cc. 33*67e74705SXin Li 34*67e74705SXin LiThe '--' at the end is important as it prevents `clang-check` from search for a 35*67e74705SXin Licompilation database. For more information on how to setup and use `clang-check` 36*67e74705SXin Liin a project, see :doc:`HowToSetupToolingForLLVM`. 37