Add missing 'Coverage' doc (#3242)

diff --git a/doc/antora/modules/developers/nav.adoc b/doc/antora/modules/developers/nav.adoc
index 5a54ed14d3f4c1efc096e248cb5c23a77b454288..eff0da4ec2d6ec75a9e610a62be8fdf6c96091d0 100644 (file)
--- 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
new file mode 100644 (file)
index 0000000..af6048e
--- /dev/null
+++ 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
index 697f2f583e2557189ab629958968c49935677c50..83b2d90675d23854d8dc442fafa3e20454e8360c 100644 (file)
--- 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]