CLANG-CHECK(1)

👑 CLANG-CHECK — the manual page, bestie edition 💅

okay so real talk, this is the manual page for clang-check from the User Commands girlies, version 16. she's that girl. let's get into it 🫶

---

✨ NAME ✨

clang-check — manual page for clang-check 16 🎀

---

🌸 DESCRIPTION 🌸

USAGE:

clang-check [options] <source0> [... <sourceN>]

OPTIONS:

---

🦋 Generic Options 🦋

• --help — shows you all the available options. and if you're nosy (same bestie, same) add --help-hidden for even more 👀
• --help-list — shows you a list of the available options. and again, --help-list-hidden if you wanna see the hidden ones too 🙈
• --version — tells you which version of this program you're running. icon behaviour fr ⭐

---

💖 clang-check options 💖

• --analyze — runs the static analysis engine 🔥
• --analyzer-output-path=<string> — writes the output to <file> 📝
• --ast-dump — builds ASTs and then debug dumps them 💀
• --ast-dump-filter=<string> — use this with -ast-dump or -ast-print to dump/print only the AST declaration nodes that have a certain substring in a qualified name. and use -ast-list to list all the filterable declaration node names, iykyk 🔍
• --ast-list — builds ASTs and prints the list of declaration node qualified names 📋
• --ast-print — builds ASTs and then pretty-prints them. pretty-privilege ✨
• --extra-arg=<string> — an additional argument to append to the compiler command line ➕
• --extra-arg-before=<string> — an additional argument to prepend to the compiler command line ⬅️
• --fix-what-you-can — applies fix-it advice even when there are unfixable errors hanging around 🩹
• --fixit — applies fix-it advice to the input source 🛠️
• -p <string> — build path 🏗️
• --syntax-tree-dump — dumps the syntax tree 🌳
• --tokens-dump — dumps the preprocessed tokens 🎟️

---

🌈 the build path lore 🌈

-p <build-path> is what you use to read a compile command database.

so for example, it can totally be a CMake build directory where a file named compile_commands.json exists. (use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option to get this output, bestie 💅). and when no build path is specified, a search for compile_commands.json will be attempted through all parent paths of the first input file.

if you want an example of setting up Clang Tooling on a source tree, it's here:

https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html

---

🍓 the source files 🍓

<source0> ... specify the paths of source files. no cap, these paths are looked up in the compile command database. so here's the tea:

• if the path of a file is absolute, it needs to point into CMake's source tree.
• if the path is relative, the current working directory needs to be in the CMake source tree, and the file must be in a subdirectory of the current working directory.

"./" prefixes in the relative files will be automatically removed, but the rest of a relative path must be a suffix of a path in the compile command database. periodt 💅

---

🧚 examples, because we love a demo 🧚

for example, to run clang-check on all files in a subtree of the source tree, use:

find path/in/subtree -name '*.cpp'|xargs clang-check

or, using a specific build path:

find path/in/subtree -name '*.cpp'|xargs clang-check -p build/path

⚠️ note that path/in/subtree and the current directory should follow the rules described above. don't skip the rules, they're the rules 😭

---

and that's the whole page, bestie. main character manual energy only 👑

signing off: clang-check 16, October 2023, CLANG-CHECK(1) — mwah, take care of yourselves 💖✨🎀