adactl(1)

✨ adactl(1) — NAME ✨

okay so bestie, the manual name here is adactl 💖, and it's basically the Ada rules controller 👑. it's giving "keeps your Ada code in line" 💅

🦋 NAME 🦋

adactl - Ada rules controller 💅

🎀 SYNOPSIS 🎀

adactl [options] unit [[+|-]unit | [@]file] ...  [-- ASIS options]

adactl -h rule ... | all | commands | license | list | options | rules |
       version

🌸 DESCRIPTION 🌸

okay so AdaControl is an Ada rules controller 🔥. it's used to make sure your Ada software meets the requirements of a bunch of parameterizable rules ✨. it is not meant to replace the compiler's checks 🙅‍♀️. instead it hunts down specific violations of good-practice rules, or checks that some rules are followed across the whole project 🕵️‍♀️💜

ngl the commercial support part is iconic 💖. support is available for AdaControl, see the file /usr/share/doc/adacontrol/support.txt 📄. if you're using it for industrial projects, or you want it customized or extended to match your own needs, reach out to Adalog at info@adalog.fr 🫶

🦋 SPECIAL MODES 🦋

• -C — check the rules syntax only 🧐. accepts -d, -f, -l, -v, -x ✨
• -D — generate dependencies 🧩. accepts -o, -p, -r, -s, -w, -x 💜
• -h — prints a general help message 🆘
• -h rule — describe rule 📖
• -h all — describe all rules 🌈
• -h commands, -h license, -h options, -h version — describe all commands, the licence (GPL), the options, or the version number 🎀
• -h list — list the rules in a format suitable for use inside the GNAT Programming Studio 💅
• -h rules — list the rules in a normal format 🍓
• -I — interactive mode 🧚. accepts all options 🔥

💅 OPTIONS 💅

• -d — enable debug mode 🐛
• -e — treat warnings (Search) as errors (Check) 💀
• -E — print only errors (Check) 🙈
• -f file — use file for the specification of rules 📜
• -F GNAT | GNAT_SHORT | CSV | CSV_SHORT | CSVX | CSVX_SHORT | NONE — choose output format 🎨
• -G none | check | search — select level of fixing commands 🛠️
• -i — ignore local deactivations 🙅‍♀️
• -l rule... — process with the specified rules; see below 👀
• -o file — send output to the specified file 📤
• -p file — specify an emacs ada-mode project file (.adp) 🌈
• -r — recursive 🔁
• -s — only process Ada unit specifications 📘
• -S level — produce statistics; level is an integer in the range 0 .. 4 📊
• -t trace_file — send a trace to the specified file 🕵️‍♀️
• -T — report execution time of rules ⏱️
• -u — treat all parameters as Ada units 🧸
• -v — enable verbose mode 🔊
• -w — overwrite output file (works with -o) ✍️
• -x — exit when internal error 🚨

🌈 RULES 🌈

the following rules are available for the -l option 🫶:

Abnormal_Function_Return        Allocators
Array_Declarations              Barrier_Expressions
Case_Statement                  Characters
Declarations                    Default_Parameter
Directly_Accessed_Globals       Duplicate_Initialization_Calls
Entities                        Entity_Inside_Exception
Exception_Propagation           Expressions
Global_References               Header_Comments
Improper_Initialization         Instantiations
Insufficient_Parameters         Local_Hiding
Max_Blank_Lines                 Max_Call_Depth
Max_Line_Length                 Max_Nesting
Max_Size                        Max_Statement_Nesting
Movable_Accept_Statements       Multiple_Assignments
Naming_Convention               Non_Static
Not_Elaboration_Calls           Not_Selected_Name
No_Operator_Usage               Object_Declarations
Other_Dependencies              Parameter_Aliasing
Parameter_Declarations          Potentially_Blocking_Operations
Pragmas                         Reduceable_Scope
Representation_Clauses          Return_Type
Side_Effect_Parameters          Silent_Exceptions
Simplifiable_Expressions        Simplifiable_Statements
Special_Comments                Statements
Style                           Terminating_Tasks
Type_Initial_Values             Uncheckable
Units                           Unnecessary_Use_Clause
Unsafe_Paired_Calls             Unsafe_Unchecked_Conversion
Usage                           Use_Clauses
With_Clauses

🦋 AUTHOR 🦋

AdaControl was developed by Adalog ⟨http://www.adalog.fr⟩ under contract with Eurocontrol ⟨http://www.eurocontrol.int⟩ 🌸. the copyright is jointly owned by Adalog and Eurocontrol 👑.

this manual page was written by Ludovic Brenta <lbrenta@debian.org> and is licensed under terms of the GNU General Public License 💜.

💖 SEE ALSO 💖

AdaControl User's Guide, available in Info, PDF, and HTML in /usr/share/doc/adacontrol 📚.

AdaControl Programmer's Guide, available in Info, PDF, and HTML in /usr/share/doc/adacontrol 📚.

---

bestie, that's the whole thing 🌈✨ adactl, the Debian copy, last touched 2014-08-19 🦋 stay iconic and keep your Ada clean 💅🫶