Merge pull request #218 from kovach/checking-short

code quality checks

Author: scottswift

CMakeLists.txt

@@ -76,3 +76,13 @@ add_subdirectory(src)
 add_subdirectory(docs)
 add_subdirectory(tests)
 
+# Must match setting inside Doxyfile
+set(DOXYGEN_WARNINGS "docs/doxygen_warnings.txt")
+set(ALLOWED_DOXYGEN_WARNINGS ${PROJECT_SOURCE_DIR}/checks/allowed_doxygen_warnings.txt)
+
+# TODO add srcs dependency
+add_custom_target(check-doxygen 
+  COMMAND diff ${ALLOWED_DOXYGEN_WARNINGS} ${DOXYGEN_WARNINGS}
+  DEPENDS docs swiftnav-static)
+
+add_custom_target(check-style DEPENDS check-doxygen checkpatch)

DEVELOPMENT.md

@@ -0,0 +1,20 @@
+libswiftnav development
+=======================
+
+Follow these instructions if you intend to make changes to libswiftnav.
+
+Tools needed:
+ * 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`.
+
+This makes the directory if it doesn't already exist, runs cmake with `Coverage` mode enabled
+inside it, and installs a git pre-commit hook that runs style and code-coverage checkers
+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`.

checks/allowed_doxygen_warnings.txt

@@ -0,0 +1,2 @@
+#echo "HEY: git diff $1 | $2 --no-tree - > check_output.txt"
+git diff $1 | $2 --no-tree - > check_output.txt