blob: 5df79adca682565d2af9de455d67db809c371f50 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
cimple
======
My little CI system (hopefully).
_This is work in progress; it doesn't quite work the way I want it to yet._
Development
-----------
Build using CMake.
Depends on json-c, libgit2, libsodium and SQLite.
There's a Makefile with useful shortcuts to build the project in the "build/"
directory:
make build
This command makes a CMake build directory in build/cmake/ and executes `make`
there.
The default is to build using clang in `Debug` configuration.
You can choose a different compiler and configuration like so:
make build COMPILER=gcc CONFIGURATION=Release
### Testing
After building, you can run the "test suite" (depends on Pytest).
make test
### Code coverage
You can generate a code coverage report (depends on `gcovr`) in
build/coverage/:
make coverage
The latest code coverage report for the `master` branch can be found at
https://egor-tensin.github.io/cimple/coverage/.
### Flame graphs
Some performance analysis can be done by looking at flame graphs.
Generate them after building the project (depends on `perf` & [FlameGraph]):
make test/perf
[FlameGraph]: https://github.com/brendangregg/FlameGraph
This will generate two flame graphs in build/flame_graphs/; they stress
slightly different parts of the system:
* [flame_graph_output_simple.svg] for a CI script with short output,
* [flame_graph_output_long.svg] for a CI script with long output.
[flame_graph_output_simple.svg]: https://egor-tensin.github.io/cimple/flame_graphs/flame_graph_output_simple.svg
[flame_graph_output_long.svg]: https://egor-tensin.github.io/cimple/flame_graphs/flame_graph_output_long.svg
Follow the links above to view the latest flame graphs for the `master` branch.
### Code style
Set up the git pre-commit hook by running `./scripts/setup-hooks.sh`.
This depends on `clang-format` and won't allow you to commit code that doesn't
pass the formatting check.
Rationale
---------
The goal it to make a CI system that doesn't suck.
See [rationale.md] for details.
[rationale.md]: doc/rationale.md
License
-------
Distributed under the MIT License.
See [LICENSE.txt] for details.
[LICENSE.txt]: LICENSE.txt
|
