Add missing 'Coverage' doc (#3242)

FreeRADIUS · Jan 16, 2020 · da0fd8e · da0fd8e
1 parent 9cb8686
commit da0fd8e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/doc/antora/modules/developers/nav.adoc b/doc/antora/modules/developers/nav.adoc
@@ -1,6 +1,7 @@
 * xref:index.adoc[Developers]
 ** xref:bugs.adoc[Bugs]
 ** xref:coding-methods.adoc[Coding Methods]
+** xref:coverage.adoc[Code Coverage]
 ** xref:profile.adoc[Profiling]
 ** xref:contributing.adoc[Contributing]
 ** xref:module_interface.adoc[Module Interface]

diff --git a/doc/antora/modules/developers/pages/coverage.adoc b/doc/antora/modules/developers/pages/coverage.adoc
@@ -0,0 +1,11 @@
+= Code Coverage
+
+We use the link:https://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html#Gcov-Intro[gcov] tool to know our tests coverage.
+
+[source,shell]
+----
+$ make clean
+$ make coverage
+----
+
+If completed with success, a pretty report will be available in `${source_tree}/build/coverage/index.html`
diff --git a/doc/antora/modules/developers/pages/index.adoc b/doc/antora/modules/developers/pages/index.adoc
@@ -6,6 +6,7 @@ List with some usual howtos for FreeRADIUS.
 
 * xref:bugs.adoc[Bugs]
 * xref:coding-methods.adoc[Coding Methods]
+* xref:coverage.adoc[Code Coverage]
 * xref:profile.adoc[Profiling]
 * xref:contributing.adoc[Contributing]
 * xref:installation:dependencies.adoc[Build dependencies]