improved readme

test target cleans up profiling files
generalized run-coverage

Author: kovach

DEVELOPMENT.md DEVELOPMENT.rstDEVELOPMENT.md renamed to DEVELOPMENT.rst

@@ -4,11 +4,12 @@ libswiftnav development
 Follow these instructions if you intend to make changes to libswiftnav.
 
 Tools needed:
- * doxygen
- * convert from ImageMagick
- * pip install gcovr diff-cover
+ - doxygen
+ - convert from ImageMagick
+ - pip install gcovr diff-cover
 
 To get started, run::
+
   ./checks/setup-hooks.sh [DIR]
 
 from within the libswiftnav root directory. The default build-dir will be `build`.
@@ -18,3 +19,18 @@ inside it, and installs a git pre-commit hook that runs style and code-coverage
 in this build directory. These checks require doxygen, gcovr, and diff-cover
 
 To manually run the coverage task, use `make check-coverage`. For syntax, use `make check-style`.
+
+Issues
+======
+
+**"No lines with coverage information in this diff."**
+
+You may see this in the output from diff-cover.
+
+Did you set up your build with::
+
+  cmake -DCMAKE_BUILD_TYPE=Coverage ..
+
+or with the :code:`setup-hooks.sh` script? The :code:`Coverage` flag is
+required.  If you are manually running the coverage script, make sure you run
+it from within your build directory.

README.md

@@ -12,3 +12,4 @@ Full documentation available online at http://docs.swift-nav.com/libswiftnav
 
 For installation, see docs/install.dox
 
+For development help, see DEVELOPMENT.rst.

checks/run-coverage.sh

@@ -1,7 +1,9 @@
 # requires gcovr and diff-cover
 # pip install gcovr diff-cover
 set -e
-gcovr -r .. --object-directory . --xml -o ../.coverage.xml
-gcovr -r .. --object-directory . --html -o coverage.html
-( cd .. && diff-cover .coverage.xml --fail-under=85 --html-report .diffreport.html )
-mv ../.diffreport.html ./diffreport.html
+base="$(git rev-parse --show-toplevel)"
+echo "running coverage check from ${base}"
+gcovr -r "${base}" --object-directory . --xml -o "${base}/.coverage.xml"
+gcovr -r "${base}" --object-directory . --html -o coverage.html
+( cd "${base}" && diff-cover .coverage.xml --fail-under=85 --html-report .diffreport.html )
+mv "${base}/.diffreport.html" ./diffreport.html

src/CMakeLists.txt

@@ -74,7 +74,6 @@ add_custom_command(
   VERBATIM
   COMMAND "${PROJECT_SOURCE_DIR}/checks/checkoutput.sh"
     "${PROJECT_SOURCE_DIR}/src/*.c"
-    "${PROJECT_SOURCE_DIR}/checks/checkpatch.pl"
-    )
+    "${PROJECT_SOURCE_DIR}/checks/checkpatch.pl")
 
 add_custom_target(checkpatch DEPENDS checkpatch_output.txt) 

tests/CMakeLists.txt

@@ -52,13 +52,19 @@ else (CMAKE_CROSSCOMPILING)
       COMMAND test_libswiftnav
     )
 
+    add_custom_target(clean_profiling
+      COMMAND find . -name "*.gcno" -delete
+      COMMAND find . -name "*.gcda" -delete
+      WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    )
+
     # for convenience:
     add_custom_target(tests
-      DEPENDS test_libswiftnav
+      DEPENDS test_libswiftnav clean_profiling
       COMMAND test_libswiftnav
     )
     add_custom_target(test
-      DEPENDS test_libswiftnav
+      DEPENDS test_libswiftnav clean_profiling
       COMMAND test_libswiftnav
     )