Code Vault

xaizek / uncov (License: AGPLv3+) (since 2018-12-07)

Uncov(er) is a tool that collects and processes code coverage reports.

Clone URLs: https://code.reversed.top/user/xaizek/uncov ssh://rocketgit@code.reversed.top/user/xaizek/uncov

<root> / INSTALL.md (a696f1f4c5b587496ab58bd27eefb79ec606f4be) (1,549B) (mode 100644) [raw]

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

### Building ###

#### Defaults ####

By default debug version is build right in the source tree.

#### Targets ####

**`debug`**

Builds debug version in `debug/`.

**`release`**

Builds release version in `release/`.

**`sanitize-basic`**

Builds debug version with undefined and address sanitizers enabled in
`sanitize-basic/`.

**`man`**

Rebuilds manual page in `<out>/docs/uncov.1`, requires `pandoc`.

**`coverage`**

Builds coverage in `coverage/` and commits it using `uncov` itself (which should
be installed).

**`self-coverage`**

Builds coverage in `coverage/` and commits it using just built `uncov`.

**`check`**

Builds and runs tests.  Combine with `debug`, `release` or `sanitize-basic` to
build and run tests in that configuration.

**`clean`**

Removes build artifacts for all configurations.

**`install`**

Builds the application in release mode (`release` target) and installs it.
`DESTDIR` can be set to point to root of the installation directory.

**`uninstall`**

Removes executable and man page.  Do specify `DESTDIR` if it was specified on
installation.

#### Documentation ####

Rebuilding a man-page requires `pandoc` to be installed.

### Installation ###

A regular installation under `/usr/bin` can be done like this:

```
make install
```

Installation into custom directory (e.g. to make a package):

```
make DESTDIR=$PWD/build install
```

### Uninstallation ###

Similar to installation, but using `uninstall` target:

```
make uninstall
```

Or for custom location:

```
make DESTDIR=$PWD/build uninstall
```

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