IWYU_TOOL.PY(1)

📦 version 8.23, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

iwyu_tool.py — the Include-what-you-use compilation database driver 💖

(we're in the User Commands section btw, so you know this is the real-deal runnable girlie and not some library deep lore 🫶)

🎀 DESCRIPTION 🎀

okay bestie so here's the vibe. You run it like this:

usage: iwyu_tool.py [-h] [-v] [-o {clang,iwyu}] [-j JOBS] -p
<build-path>

[source [source ...]] -- [<IWYU args>]
[source [source ...]]

and it is literally the Include-what-you-use compilation database driver. That's the whole job description. She drives the compilation database. Main character energy only 💅

🌸 positional arguments 🌸

  • source — zero or more source files to run IWYU on. Zero!! As in, if you don't name any, she just defaults to all of them in the compilation database. Not me handing over the aux 🎀

⭐ optional arguments ⭐

  • -h, --help — show this help message and exit. The classic. The icon. The "I forgot the flags again" savior 🙈
  • -v, --verbose — print the IWYU commands. Yes queen, show your work, we love transparency ✨
  • -o {clang,iwyu}, --output-format {clang,iwyu} — output format, and the default is iwyu. Pick your fighter: clang or iwyu 🌈
  • -j JOBS, --jobs JOBS — number of concurrent subprocesses. Go parallel, go fast, go feral 🔥
  • -p <build-path> — the compilation database path. This one's required, no cap, she will not guess where your build lives 💀
also important: she assumes include-what-you-use is available on the PATH. So if it's not on your PATH, that's a you problem, not a her problem 😭 fix your PATH bestie.

that's it, that's the page — short, sweet, slays 🌸

this lil masterpiece is iwyu_tool.py version 6.0-2, dated September 2018 — an absolute vintage icon, and yes she still ate 👑

📦 where this page comes from