CLANG-INCLUDE-FIXER(1)

๐Ÿ“ฆ
version 13.0.1 ยท 3 versions
, in ubuntu jammy

๐Ÿ’– NAME ๐Ÿ’–

okay so bestie, welcome to clang-include-fixer โ€” manual page for clang-include-fixer 13, filed under User Commands, and honestly she's the friend who always knows where the thing is. this whole page is her. ๐Ÿ’…


๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

โœจ USAGE โœจ

clang-include-fixer [options] <source0> [... <sourceN>]

that's the whole vibe: you give her some source files โ€” <source0> all the way out to <sourceN> โ€” you sprinkle on some [options], and she handles the rest. main character energy, no notes. ๐Ÿซถ


๐ŸŽ€ OPTIONS ๐ŸŽ€

๐ŸŒˆ Generic Options

  • --help โ€” shows you all the available options she's got. want the secret menu too? that's --help-hidden, and it's giving extra. ๐Ÿ‘€
  • --help-list โ€” prints out a list of the available options. and yes, there's a --help-list-hidden for more, because of course there is. โœจ
  • --version โ€” tells you which version of this program you're running. a lil identity check, love that for her. ๐Ÿชช

๐Ÿงš Tool options

  • --db=<value> โ€” tells her the input format to use. here's the menu of <value>s:
    • =fixed โ€” hard-coded mapping. old reliable. ๐Ÿ’€
    • =yaml โ€” a Yaml database that was created by find-all-symbols.
    • =fuzzyYaml โ€” a Yaml database, except the names are fuzzy-matched. soft focus, very demure. ๐ŸŒธ
  • --extra-arg=<string> โ€” one extra argument, appended to the compiler command line. little bonus at the end. โœจ
  • --extra-arg-before=<string> โ€” one extra argument, but prepended to the compiler command line. she goes first, obviously, she's the main character. ๐Ÿ‘‘
  • --input=<string> โ€” a string used to initialize the database. ๐Ÿ“
  • --insert-header=<string> โ€” insert one specific header. > heads up bestie: this one should run with STDIN mode. The result is written to stdout, and it's currently used for editor integration. It supports YAML/JSON format:
-insert-header="{
  FilePath: "/path/to/foo.cc", QuerySymbolInfos: [
  {RawIdentifier: foo,
  Range: {Offset: 0, Length: 3}}
  ], HeaderInfos: [ {Headers: "\"foo_a.h\"",
  QualifiedName: "a::foo"} ]}"
  • --minimize-paths โ€” whether to minimize the added include paths. tidy queen. ๐Ÿงน
  • --output-headers โ€” prints the symbol being queried and all its relevant headers in JSON format to stdout:
{
  "FilePath": "/path/to/foo.cc", "QuerySymbolInfos": [
  {"RawIdentifier": "foo",
  "Range": {"Offset": 0, "Length": 3}}
  ], "HeaderInfos": [ {"Header": "\"foo_a.h\"",
  "QualifiedName": "a::foo"} ]
}
  • -p=<string> โ€” the build path. ๐Ÿ“
  • -q โ€” reduces terminal output. less yapping, more doing. ๐Ÿคซ
  • --query-symbol=<string> โ€” query a given symbol directly in the database (like, say, "a::b::foo") without even parsing the file. she just knows. ๐Ÿ”ฎ
  • --stdin โ€” overrides the source file's content (in the overlaying virtual file system) with input from <stdin>, then runs the tool on that new content using the compilation options of the source file. This mode is currently used for editor integration. ๐Ÿ–ฅ๏ธโœจ
  • --style=<string> โ€” the fallback style for reformatting after inserting new headers, used when there's no clang-format config file found. she's got a backup fit. ๐Ÿ’œ

ngl bestie, that's the whole page โ€” every option, every value, every default, all accounted for. nothing skipped, nothing invented. iykyk. ๐ŸŒˆ

and that's a wrap!! this was clang-include-fixer 13, from July 2023, living her best life in the User Commands manual. go fix some includes, you absolute icon. ๐Ÿ’–๐ŸŽ€๐Ÿฆ‹โœจ

๐Ÿ“ฆ where this page comes from