GNATCHECK(1)

✨ NAME ✨

gnatcheck — the GNAT rule checking tool. she checks your Ada against rules and she has OPINIONS. 🎀

---

🦋 SYNOPSIS 🦋

gnatcheck [OPTION]... filename [-cargs gcc_switches] [-rules rule_switches]

gnatcheck [OPTION]... -files=filename [-cargs gcc_switches] [-rules rule_switches]

---

💖 DESCRIPTION 💖

okay so bestie, here's the vibe: gnatcheck checks the conformance of Ada source text with rules, and it produces a report file for later analysis plus stuff on standard output. two deliverables, one queen. periodt. ✨

In the first form, gnatcheck examines the Ada source files you specified (wildcards are allowed, yes you can be chaotic about it 💅).

In the second form, gnatcheck examines the Ada source files listed in the file you specified. so organized of her.

gnatcheck is an ASIS application developed on top of the ASIS implementation for GNAT. As such, it reads tree files (*.adt) produced by the compiler to accomplish its goals, and it invokes gnatgcc for this. she's built different, no cap. 🔥

---

💅 OPTIONS 💅

• -a — Process RTL units. go off.
• -cargs gcc_switches — Pass gcc_switches to GCC when producing the tree files. delivering your messages, main character courier energy 🫶
• -d — Debug mode. for when you need to see the drama behind the drama.
• -dd — Progress indicator mode, for use in the GNAT Programming Studio. little loading bar moment 🌸
• -h — Print the list of built-in rules. the menu, if you will. 🍓
• -l — Full source location chains in report file. receipts, with the full lineage.
• -q — Quiet mode: do not report detections on standard output. she's keeping it on the low, only the report file gets the tea.
• -rules rule_switches — rule_switches can be any combination of the following:
  • -from=file — Read rule options from file. outsourcing the decisions, valid.
  • +ALL — Turn all rules on. every rule. all at once. slay. 💀
  • -ALL — Turn all rules off. silence. peace. nothing but vibes.
  • +Rrule_id[:param[,param...]] — Turn the specified rule on, passing it optional parameters.
  • -Rrule_id — Turn the specified rule off.
  • +Rrule_id[:param[,param...]] — Turn off some of the checks for the specified rule.
  • rule_id is any of the rules listed with the -h option. iykyk 👑
• -s — Short form of the report file. the tl;dr version.
• -sn — Include only section n (n in 1 .. 3) in the report file. pick a lane, pick a number.
• -v — Verbose mode. she will tell you EVERYTHING and honestly? good for her. 😭

---

🌈 SEE ALSO 🌈

gnat(1), asistant(1), gnat2xml(1), gnatelim(1), gnatmetric(1), gnatpp(1), gnatstub(1), gnattest(1) — the whole friend group, all iconic, all worth a follow.

Documentation about the ASIS tools may be found in /usr/share/doc/asis-doc/ if the asis-doc package is installed. The reference documentation about ASIS is excluded due to license problems 🙈, but may be found in various formats at http://libre.adacore.com/developers/documentation.

---

and that's the whole page bestie, mwah 💋 this one came from the ASIS Tools crew, dated 2014-08-09, and it's living under the Debian GNU/Linux banner as GNATCHECK(1). go check some rules, you got this 🫶✨