2022-02-08 14:56:04 +03:00
|
|
|
# Clerk
|
|
|
|
|
2022-02-22 20:59:07 +03:00
|
|
|
The build system for Catala built on top of [ninja](https://ninja-build.org/).
|
2022-02-08 14:56:04 +03:00
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2022-02-24 15:45:16 +03:00
|
|
|
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.
|
2022-02-08 14:56:04 +03:00
|
|
|
|
2022-02-22 20:59:07 +03:00
|
|
|
## Under the hood
|
2022-02-08 14:56:04 +03:00
|
|
|
|
2022-02-22 20:59:07 +03:00
|
|
|
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`.
|
2022-02-08 14:56:04 +03:00
|
|
|
|
2022-02-22 20:59:07 +03:00
|
|
|
The handling of the `ninja` structure is done with the module `Ninja_utils`.
|