xaizek / uncov (License: AGPLv3+) (since 2018-12-07)
Uncov(er) is a tool that collects and processes code coverage reports.
<root> / docs / uncov-gcov / 04-usage.md (7b619aef67b8a8b681edd476b8a42a94e946b26e) (849B) (mode 100644) [raw]
USAGE
=====

uncov-gcov can be used to generate coverage, but it seems to not play well with
out-of-tree builds (some coverage is missing, this issue is inherited from its
origin), so the recommended way of recording coverage information is as follows:

```
# reset coverage counters from previous runs
find . -name '*.gcda' -delete

# run tests here with something like `make check`

# generage coverage for every object file found (change "." to build root)
find . -name '*.o' -exec gcov -p {} +

# generage and combine coverage reports (-\-capture-worktree automatically
# makes stray commit if repository is dirty)
uncov-gcov -\-root . -\-no-gcov -\-capture-worktree -\-exclude tests | uncov new

# remove coverage reports
find . -name '*.gcov' -delete
```

These commands can be put in a separate script or embedded directly into build
system.
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/uncov

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/uncov

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master