From ecd8eb79124f7b2609ba2ac1adc90d42cd79ae0f Mon Sep 17 00:00:00 2001 From: Soonho Kong Date: Sat, 17 Aug 2013 20:51:26 -0700 Subject: [PATCH] Update README.md to include instructions for tests, coverage, and doxygen --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 7cf827f97..d7921a7e1 100644 --- a/README.md +++ b/README.md @@ -120,3 +120,38 @@ Instructions for RELEASE build [cmake]: http://www.cmake.org/ [ninja]: http://martine.github.io/ninja/ + +Instructions for Testing and Measuring Code Coverage +==================================================== + +To measure [code coverage][cover], compile TESTCOV build using g++: + + mkdir -p build/testcov + cd build/testcov + cmake -DCMAKE_BUILD_TYPE=TESTCOV -DCMAKE_CXX_COMPILER=g++-4.8 -G Ninja ../../src + ninja + +and run test cases: + + ctest + +and collect coverage data using [lcov][lcov] and [gcov][gcov]: + + lcov -c -b ../../src -d . -o cov.info --no-external --gcov-tool gcov-4.8 + +and generate HTML output: + + genhtml cov.info --output-directory lcov + +Note: make sure that the version of ``gcov`` matches with the one of +``g++``. Also try to use the latest ``lcov`` if you have a problem +with the existing one. + +[gcov]: http://gcc.gnu.org/onlinedocs/gcc/Gcov.html +[lcov]: http://ltp.sourceforge.net/coverage/lcov.php +[cover]: https://dl.dropboxusercontent.com/u/203889738/lcov/index.html + +Instructions for Building Doxygen Documentation +=============================================== + + doxygen src/Doxyfile