Skip to content

Commit e879d7d

Browse files
lsf37Indanz
authored andcommitted
README: fix markdown lints
Headings and lists should be surrounded by empty lines. Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
1 parent 4ba9582 commit e879d7d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ seL4test (this project).
1919
*Small unit tests* can be defined anywhere, such as libraries outside of `sel4test` or in `sel4test-driver`. *Larger tests* that do things like creating processes need to be declared inside `sel4test-tests`.
2020

2121
### Unit tests
22+
2223
To define a small unit test in a library outside of `sel4test` or in `sel4test-driver`:
24+
2325
1. Declare `libsel4test` as a dependency for your library and include `<sel4test/test.h>`. You may also find the functions in `<sel4test/testutil.h>` handy.
2426
2. Write your tests. Then, for each test you want to run, call one of the macros that define a test, such as the `DEFINE_TEST` macro. They are declared
2527
[here](https://github.com/seL4/seL4_libs/blob/master/libsel4test/include/sel4test/test.h#L88).
@@ -30,11 +32,14 @@ Add a call to any function in your test file to `testreporter.c` in [`dummy_func
3032
For an example, take a look at [`libsel4serialserver/src/test.c`](https://github.com/seL4/seL4_libs/blob/master/libsel4serialserver/src/test.c) in `sel4_libs`.
3133

3234
### Assumptions
35+
3336
Currently unit tests are assumed to be running sequentially, standalone (i.e. not multi-threaded).
3437
Some tests rely on being the highest priority running thread in the system.
3538

3639
### Other tests
40+
3741
To define a larger test in `sel4test-tests`:
42+
3843
1. Place your test in `apps/sel4test-tests/src/tests`.
3944
2. Include `<../helpers.h>`.
4045
3. Write your tests. Then, for each test you want to run, call one of the macros that define a test,

0 commit comments

Comments
 (0)