OPTIONS
=======
**-\-help, -h**
---------------
Displays short usage help.
**-\-version, -v**
------------------
Displays version information.
**-\-verbose**
--------------
Print verbose messages.
**-\-dryrun**
-------------
Run the script without printing report.
**-\-gcov** [=gcov]
-------------------
Set the location of gcov.
**-\-gcov-options** [=""]
-------------------------
Set the options given to gcov.
**-r**, **-\-root** [=.]
------------------------
Set the root directory.
**-b**, **-\-build-root** [={discovered}]
-----------------------------------------
Set the directory from which gcov will be called; by default gcov is run in the
directory of the .o files; however the paths of the sources are often relative
to the directory from which the compiler was run and these relative paths are
saved in the .o file; when this happens, gcov needs to run in the same directory
as the compiler in order to find the source files.
**-\-collect-root** [={value of -\-root}]
----------------------------------------
Directory to look gcov files in.
**-e**, **-\-exclude** [=""]
----------------------------
List of paths to exclude. Can be specifieid multiple times.
Examples:
uncov-gcov -\-exclude build-release -\-exclude build-debug ...
uncov-gcov -\-exclude build-release build-debug ...
uncov-gcov -\-exclude build* ...
**-i**, **-\-include** [=""]
----------------------------
List of paths to include. Can be specifieid multiple times. See **-\-exclude**
for examples.
**-E**, **-\-exclude-pattern** [=""]
------------------------------------
Set exclude file/directory pattern.
**-x**, **-\-extension** [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm]
--------------------------------------------------------------------
Set extension of files to process.
**-n**, **-\-no-gcov**
----------------------
Do not run gcov.
**-\-encodings** [=utf-8,latin-1]
---------------------------------
Source encodings to try in order of preference.
**-\-dump** \<file\>
--------------------
Dump JSON payload to a file.
**-\-follow-symlinks**
----------------------
Follow symlinks.
**-c**, **-\-capture-worktree**
-------------------------------
Make a dangling commit if working directory is dirty.
**-\-ref-name** [={discovered}]
-------------------------------
Force custom ref name.
**-\-cpp-dtor-invocations**
---------------------------
Count coverage for C++ destructor invocations, which tends to show up at lines
that have the closing brace (`{`).
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