summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorBo Borgerson <gigabo@gmail.com>2008-04-30 08:49:59 -0400
committerJim Meyering <meyering@redhat.com>2008-04-30 16:09:33 +0200
commitbbc49eb5368f9f19b66562210a4eb60ff5cfe153 (patch)
tree95adc5ad4cb323d336df6f1ae60e69a75ee9e7ce /HACKING
parentbbc0cb0f37641b1779170b3e15bd3479fb250fed (diff)
downloadcoreutils-bbc49eb5368f9f19b66562210a4eb60ff5cfe153.tar.xz
Add Daniel Dunbar's lcov instructions to HACKING
* HACKING: New section `Finding things to do', points to TODO file and gives instructions on generating an html coverage report as provided by Daniel Dunbar. * TODO: Add item for improving test coverage. Point back to HACKING. Signed-off-by: Bo Borgerson <gigabo@gmail.com>
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING27
1 files changed, 27 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index b40ff0058..c33bdd376 100644
--- a/HACKING
+++ b/HACKING
@@ -317,3 +317,30 @@ Miscellaneous useful git commands
* git rebase -i master: run this from on a branch, and it gives
you an interface with which you can reorder and modify arbitrary
change sets on that branch.
+
+-------------------------------------------
+
+Finding things to do
+====================
+If you don't know where to start, check out the TODO file for projects
+that look like they're at your skill-/interest-level. Another good
+option is always to improve tests. You never know what you might
+uncover when you improve test coverage, and even if you don't find
+any bugs your contribution is sure to be appreciated.
+
+A good way to quickly assess current test coverage is to use "lcov"
+to generate HTML coverage reports. Follow these steps:
+
+ # configure with coverage information
+ ./configure CFLAGS="-g -fprofile-arcs -ftest-coverage"
+ make
+ # run whatever tests you want, i.e.:
+ make check
+ # run lcov
+ lcov -t coreutils -q -d lib -b lib -o lib.lcov -c
+ lcov -t coreutils -q -d src -b src -o src.lcov -c
+ # generate HTML from the output
+ genhtml -p `pwd` -t coreutils -q --output-directory lcov-html *.lcov
+
+Then just open the index.html file (in the generated lcov-html directory)
+in your favorite web browser.