From 6164c1d49f92e30eb2ef484cda78e09dde0f50ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Tue, 3 Oct 2023 00:58:06 +0200 Subject: Document coverage utilities. --- doc/ref/general/coverage.texi | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/ref/general/coverage.texi (limited to 'doc/ref/general/coverage.texi') diff --git a/doc/ref/general/coverage.texi b/doc/ref/general/coverage.texi new file mode 100644 index 00000000..0c831d40 --- /dev/null +++ b/doc/ref/general/coverage.texi @@ -0,0 +1,43 @@ +@node Code Coverage Utilities +@section Code Coverage Utilities + +The module @code{(hnh util coverage)} provides procedures for working +with the coverage reports returned by Guile's @code{(system vm coverage)}. + +@deftp {Immutable Record} coverage-info + +@defun coverage-info? x +@end defun + +@defvr {Record Field} filename +@end defvr + +@defvr {Record Field} lines +@end defvr + +@defvr {Record Field} total-lines +@end defvr + +@defvr {Record Field} hit-lines +@end defvr + +@end deftp + + +@defun output-coverage coverage [port=(current-output-port)] +Outputs @var{coverage} as a coverage report to @var{port}. Note that +for the output to be a valid coverage file, it must begin with ``TN:'' +as its first line, before any records. +@end defun + +@defun parse-coverage string +Parses coverage data as returned by @code{coverage-data->lcov}. (or +any pre-generated coverage data file). + +Returns a coverage-info object. +@end defun + +@defun merge-coverage a b +Merges the two given coverage info objects into one coverage info +objects. The two objects must reference the same source file. +@end defun -- cgit v1.2.3