catala/build_system
Louis Gesbert 0f9ee2c72e Refacter the main Driver module
- Use separate functions for successive passes in module `Driver.Passes`
- Use other functions for end results printing in module `Driver.Commands`

As a consequence, it is much more flexible to use by plugins or libs and we no
longer need the complex polymorphic variant parameter.

This patch leverages previous changes to use Cmdliner subcommands and
effectively specialises the flags of each Catala subcommand.

Other changes include:

- an attempt to normalise the generic options and reduce the number of global
  references. Some are ok, like `debug` ; some would better be further cleaned up,
  e.g. the ones used by Proof backend were moved to a `Proof.globals` module and
  need discussion. The printer no longer relies on the global languages and prints
  money amounts in an agnostic way.
- the plugin directory is automatically guessed and loaded even in dev setups.
  Plugins are shown by the main `catala` command and listed in `catala --help`
- exception catching at the toplevel has been refactored a bit as well; return
  codes are normalised to follow the manpage and avoid codes >= 128 that are
  generally reserved for shells.

Update tests
2023-07-03 16:42:54 +02:00
..
clerk_driver.ml Refacter the main Driver module 2023-07-03 16:42:54 +02:00
clerk.ml Big reformatting 2022-03-08 15:03:14 +01:00
dune Correctly setup ocolor on all output channels 2023-06-08 12:14:11 +02:00
ninja_utils.ml Add dune rule to build tests 2022-05-25 18:33:20 +02:00
ninja_utils.mli Fix most doc errors 2023-06-02 17:17:45 +02:00
README.md docs(clerk): add documentation about clerk and the Ninja_utils module 2022-02-24 14:05:05 +01:00

Clerk

The build system for Catala built on top of ninja.

Usage

Use clerk --help if you have installed it to get more information about the command line options available. To get the development version of the help, run make help_clerk after make build. The clerk binary corresponds to the Catala build system, responsible for testing among other things.

Under the hood

To perform tests, Clerk will first generate a build.ninja file with required rules and build statements retrieved from the given input path(s), before executing the command ninja test.

The handling of the ninja structure is done with the module Ninja_utils.