aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2013-04-06 13:23:38 +0200
committerMichael Niedermayer <michaelni@gmx.at>2013-04-06 13:23:38 +0200
commit84bfa8beb708d7594d298b438d3fa9c21630da97 (patch)
tree173f86e3bdc612efbbd168245159e14c6d66ed65 /doc
parent11d7bbb47a1e8109aef90f62eb63ce0039f23340 (diff)
parenta862c7d3368241e72a465ab944afa38ea62a6640 (diff)
downloadffmpeg-84bfa8beb708d7594d298b438d3fa9c21630da97.tar.gz
Merge commit 'a862c7d3368241e72a465ab944afa38ea62a6640'
* commit 'a862c7d3368241e72a465ab944afa38ea62a6640': Integrate lcov/gcov into Libav Conflicts: Makefile common.mak Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/developer.texi24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi
index baf7d20675..d5580d1543 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -580,6 +580,30 @@ message or introductionary message for the patch series that you post to
the ffmpeg-devel mailing list, a direct link to download the sample media.
+@subsection Visualizing Test Coverage
+
+The FFmpeg build system allows visualizing the test coverage in an easy
+manner with the coverage tools @code{gcov}/@code{lcov}. This involves
+the following steps:
+
+@enumerate
+@item
+ Configure to compile with instrumentation enabled:
+ @code{configure --toolchain=gcov}.
+@item
+ Run your test case, either manually or via FATE. This can be either
+ the full FATE regression suite, or any arbitrary invocation of any
+ front-end tool provided by FFmpeg, in any combination.
+@item
+ Run @code{make lcov} to generate coverage data in HTML format.
+@item
+ View @code{lcov/index.html} in your preferred HTML viewer.
+@end enumerate
+
+You can use the command @code{make lcov-reset} to reset the coverage
+measurements. You will need to rerun @code{make lcov} after running a
+new test.
+
@anchor{Release process}
@section Release process