summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CMock/Readme.md
blob: df2c7c105fa7228f843f6d9c639df14e2c874f79 (plain)
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
# FreeRTOS Kernel Unit Tests

## Prerequisites as tested
GCC
```
gcc: gcc (GCC) 9.2.0
```
LCOV
```
lcov: LCOV version 1.14-6-g40580cd
```
Make
```
GNU Make 3.82
```
Ruby
```
ruby 2.0.0p648 (2015-12-16) [x86_64-linux]
```
Doxygen (optional)
```
1.8.5
```
## How to run
```
$ make help
Usage: $ make <unit>

 where <unit> is one of: queue doc all run run_formatted run_col
 run_col_formatted coverage
```
Explanation
```
$ make queue
```
Would build the kernel queue unit tests and put the executable in build/bin

```
$ make doc
```
Would generate the doxygen documentation in build/doc

```
$ make run | run_formatted | run_col | run_col_formatted 
```
Would build all unit tests and runs them one after the other with different
options between normal and formatted and colored for easily spotting errors

```
$ make coverage
```
Would build all unit tests, runs them one after the other, then generates html code
coverage and places them in build/coverage with initial file index.html