Skip to content
This repository has been archived by the owner on Apr 13, 2021. It is now read-only.

Latest commit

 

History

History
57 lines (38 loc) · 1.57 KB

DEVELOPMENT.md

File metadata and controls

57 lines (38 loc) · 1.57 KB
Raw

libswiftnav development

Follow these instructions if you intend to make changes to libswiftnav.

Tools needed:

  • doxygen
  • convert from ImageMagick
  • pip install gcovr diff-cover
  • texlive and texlive-pictures
  • pgf (for missing TeX dependency)
  • libcheck (otherwise make will not run unit tests)

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.

Building/Testing Python

To build and test the python bindings use these commands:

First build and locally install libswiftnav:

cd build
make
make DESTDIR="./install" install

Then build the python bindings:

cd ../python
export LD_LIBRARY_PATH=../build/install/usr/local/lib
export DYLD_LIBRARY_PATH=../build/install/usr/local/lib
tox

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.