INSPECT(1)

πŸ’– INSPECT(1) β€” the inspect manual, bestie πŸ’–

okay so you're in the User Commands section, and this is the manual for inspect, the Boost code inspection tool. It's giving codebase health check energy, and we're gonna read it together. periodt.

✨ NAME ✨

inspect β€” Boost code inspection tool πŸ’…

🌸 SYNOPSIS 🌸

inspect [-cvs] [-text] [-brief] [options...]

πŸ’– DESCRIPTION πŸ’–

bestie, it is not uncommon for various common errors or guideline violations to creep into the Boost libraries. The inspect program detects and reports several common problems. It can be used to scan a proposed Boost submission to identify various failures. like, it's the vibe check for your submission. πŸ”₯

The program is run in the directory to be scanned for errors. Sub-directories are also included in the scan. so yes, it goes down into the folders too, no cap.

If the first program argument is -cvs, only files and directories in the CVS tree of the current directory are scanned. Otherwise all files and sub-directories are included in the scan. that's the whole rule β€” -cvs first means CVS-tree-only behavior; no -cvs first means everything gets scanned. πŸ’…

πŸŽ€ Options: πŸŽ€

These are the check names you can throw into the mix. Name your desired checks and slay. ✨

  • -license β€” one of the check names; pass it and it's a desired check. πŸ’–
  • -copyright β€” one of the check names; pass it and it's a desired check. πŸŽ€
  • -crlf β€” one of the check names; pass it and it's a desired check. πŸ¦‹
  • -link β€” one of the check names; pass it and it's a desired check. 🌸
  • -path_name β€” one of the check names; pass it and it's a desired check. πŸ’…
  • -tab β€” one of the check names; pass it and it's a desired check. 🫢
  • -ascii β€” one of the check names; pass it and it's a desired check. 😭
  • -minmax β€” one of the check names; pass it and it's a desired check. πŸ”₯
  • -unnamed β€” one of the check names; pass it and it's a desired check. πŸ‘‘
The default is to have all checks on; otherwise options specify desired checks. 🌈

πŸ”₯ SEE ALSO πŸ”₯

The full documentation for inspect is maintained in HTML; see /usr/share/doc/libboostX.Y-doc/HTML/tools/inspect/index.html πŸ“šβœ¨


xoxo bestie, that's the whole manual. This one's inspect, from July 2009, and it's INSPECT(1) β€” mwah πŸ’‹πŸ’–