Improve unit testing documentation headers and code blocks

This commit is contained in:
Vincent Sanders 2020-03-24 08:54:40 +00:00
parent 5bc21c0467
commit 06b709f71a
1 changed files with 99 additions and 100 deletions

View File

@ -1,8 +1,9 @@
NetSurf Unit Testing
====================
Overview
--------
[toc]
# Overview
NetSurf has unit tests integrated in the test directory. These tests
use the check unit test framework for C [1].
@ -13,8 +14,7 @@ programs although the framework does not madate this and some test
programs contain more than one suite.
Execution
---------
# Execution
The test programs are executed by using the standard "test" target
from the top level make invocation. The "coverage" target additionally
@ -25,8 +25,7 @@ The check library must be installed to run the tests and the CI system
automatically executes all enabled tests and generates coverage
reports for each commit.
Adding tests
------------
# Adding tests
The test/Makefile defines each indiviadual test program that should be
built and executed in the TESTS variable.