[gnome-common] code-coverage: Add some âuserâ documentation

[Philip Withnall <pwithnall src gnome org>]

commit 8704bc3ceb4804830530b412a4dddc66c74f7521
Author: Philip Withnall <philip tecnocode co uk>
Date:   Fri Sep 7 21:32:52 2012 +0100

    code-coverage: Add some âuserâ documentation

 macros2/gnome-code-coverage.m4 |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)
---
diff --git a/macros2/gnome-code-coverage.m4 b/macros2/gnome-code-coverage.m4
index d17fd9c..cfaf25b 100644
--- a/macros2/gnome-code-coverage.m4
+++ b/macros2/gnome-code-coverage.m4
@@ -22,6 +22,13 @@ dnl Makefile.am:
 dnl    @GNOME_CODE_COVERAGE_RULES@
 dnl    my_program_LIBS = â $(CODE_COVERAGE_LDFLAGS) â
 dnl    my_program_CFLAGS = â $(CODE_COVERAGE_CFLAGS) â
+dnl
+dnl This results in a âcheck-code-coverageâ rule being added to any Makefile.am
+dnl which includes â GNOME_CODE_COVERAGE_RULES@â (assuming the module has been
+dnl configured with --enable-code-coverage). Running `make check-code-coverage`
+dnl in that directory will run the moduleâs test suite (`make check`) and build
+dnl a code coverage report detailing the code which was touched, then print the
+dnl URI for the report.
 
 AC_DEFUN([GNOME_CODE_COVERAGE],[
 	dnl Check for --enable-code-coverage