xaizek / uncov (License: AGPLv3+) (since 2018-12-07)
Uncov(er) is a tool that collects and processes code coverage reports.
<root> / docs / uncov-web.1 (2c30223fe67c9016adb078eb6675535ac299e051) (1,796B) (mode 100644) [raw]
.\" Automatically generated by Pandoc
.TH "uncov-web" "1" "January 20, 2024" "uncov v0.5" ""
uncov\-web is a HTTP\-server that provides Web\-UI for browsing coverage
information collected by \f[B]uncov(1)\f[R].
\f[B]uncov\-web\f[R] \f[B]\-h|\-\-help\f[R]
\f[B]uncov\-web\f[R] \f[B]\-v|\-\-version\f[R]
\f[B]uncov\-web\f[R] \f[B]\-\-vhost\f[R] <host\-name> \f[B]\-\-ip\f[R]
[=] \f[B]\-\-repo\f[R] [=.]
\f[B]\-\-port\f[R] [=8000]
.SS \f[B]\-\-help, \-h\f[R]
Displays short usage help.
.SS \f[B]\-\-version, \-v\f[R]
Displays version information.
.SS \f[B]\-\-vhost\f[R] <host\-name>
Sets virtual host name.
This option is mandatory.
.SS \f[B]\-\-ip\f[R] [=]
IP address to bind to.
The default is to bind to all interfaces.
.SS \f[B]\-\-repo\f[R] [=.]
Path to repository.
.SS \f[B]\-\-port\f[R] [=8000]
Post to listen on.
Once started provides HTTP\-server to view coverage reports.
Does not daemonize itself.
.SS Notations
For the sake of brevity interface uses several intuitive abbreviations:
.IP \[bu] 2
Cov \[en] coverage;
.IP \[bu] 2
Ref \[en] reference (of VCS);
.IP \[bu] 2
C \[en] covered;
.IP \[bu] 2
M \[en] missed;
.IP \[bu] 2
R \[en] relevant.
\f[B]<data\-directory>\f[R] in the following is either git\-directory
for a worktree (see \f[B]git\-worktree\f[R](1)) or for the repository
that owns it, whichever has either of those files when checking
directories in the order they are mentioned.
If no files found, repository\[cq]s git\-directory is used.
\f[B]<data\-directory>/uncov.sqlite\f[R] \[en] storage of coverage data.
\f[B]<data\-directory>/uncov.ini\f[R] \[en] configuration.
\f[B]uncov\f[R](1), \f[B]uncov\-gcov\f[R](1)
xaizek <xaizek@posteo.net>.

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