From: Jorge Pereira <jpereira@users.noreply.github.com>
Date: Thu, 16 Jan 2020 23:47:55 +0000 (-0300)
Subject: Add missing 'Coverage' doc (#3242)
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=da0fd8ef4ea61f07e2fab75e4e508f8237f88220;p=thirdparty%2Ffreeradius-server.git

Add missing 'Coverage' doc (#3242)
---

diff --git a/doc/antora/modules/developers/nav.adoc b/doc/antora/modules/developers/nav.adoc
index 5a54ed14d3f..eff0da4ec2d 100644
--- 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
index 00000000000..af6048e39e7
--- /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 697f2f583e2..83b2d90675d 100644
--- 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]